diff --git a/.github/workflows/infra-deploy.yml b/.github/workflows/infra-deploy.yml index ed0a7e9fa..cddb8f749 100644 --- a/.github/workflows/infra-deploy.yml +++ b/.github/workflows/infra-deploy.yml @@ -83,7 +83,6 @@ jobs: export NODE_OPTIONS="--max_old_space_size=16384" export DOCUSAURUS_IGNORE_SSG_WARNINGS=true npm ci - npm run gen-all-api-specs-code-examples npm run gen-api-docs-all npm run build # push these files to AWS diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md new file mode 100644 index 000000000..b4c286426 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md @@ -0,0 +1,273 @@ +--- +id: beta-access-model-metadata +title: Access_Model_Metadata +pagination_label: Access_Model_Metadata +sidebar_label: Access_Model_Metadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Model_Metadata', 'BetaAccess_Model_Metadata'] +slug: /tools/sdk/python/beta/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'Access_Model_Metadata', 'BetaAccess_Model_Metadata'] +--- + +# sailpoint.beta.AccessModelMetadataApi + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + + +## get-access-model-metadata-attribute +Get Access Model Metadata Attribute +Get single Access Model Metadata Attribute + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | Technical name of the Attribute. + +### Return type +[**AttributeDTO**](../models/attribute-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | AttributeDTO | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.attribute_dto import AttributeDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + + try: + # Get Access Model Metadata Attribute + + results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-model-metadata-attribute-value +Get Access Model Metadata Value +Get single Access Model Metadata Attribute Value + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute-value) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | Technical name of the Attribute. +Path | value | **str** | True | Technical name of the Attribute value. + +### Return type +[**AttributeValueDTO**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | AttributeValueDTO | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + + try: + # Get Access Model Metadata Value + + results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-model-metadata-attribute +List Access Model Metadata Attributes +Get a list of Access Model Metadata Attributes + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute) + +### 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* + +### Return type +[**List[AttributeDTO]**](../models/attribute-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | List[AttributeDTO] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.attribute_dto import AttributeDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-model-metadata-attribute-value +List Access Model Metadata Values +Get a list of Access Model Metadata Attribute Values + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute-value) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | Technical name of the Attribute. + +### Return type +[**List[AttributeValueDTO]**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | List[AttributeValueDTO] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + + try: + # List Access Model Metadata Values + + results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md new file mode 100644 index 000000000..6a8377e7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -0,0 +1,684 @@ +--- +id: beta-access-profiles +title: Access_Profiles +pagination_label: Access_Profiles +sidebar_label: Access_Profiles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Profiles', 'BetaAccess_Profiles'] +slug: /tools/sdk/python/beta/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'Access_Profiles', 'BetaAccess_Profiles'] +--- + +# sailpoint.beta.AccessProfilesApi + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +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. + +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. + +Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + + +## create-access-profile +Create Access Profile +Use this API to create an access profile. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile | [**AccessProfile**](../models/access-profile) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Access profile created. | AccessProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile import AccessProfile +from pprint import pprint +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() + new_access_profile.from_json(access_profile) + results =AccessProfilesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile 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 | Returned when an access profile cannot be deleted as it's being used. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +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 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile_bulk_delete_request | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | + +### Return type +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse | - | +202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest +from sailpoint.beta.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse +from pprint import pprint +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() + new_access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + results =AccessProfilesApi(api_client).delete_access_profiles_in_bulk(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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An AccessProfile | AccessProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile import AccessProfile +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the access profile containing the entitlements. + 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, 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. + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Use this API to get a list of access profiles. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles) + +### 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 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. + 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* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + 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 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. + Query | include_unsegmented | **bool** | (optional) (default to True) | 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. + +### Return type +[**List[AccessProfile]**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access profiles. | List[AccessProfile] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile import AccessProfile +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* 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* 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 | 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) # str | 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) + 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: +**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Access Profile as updated. | AccessProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile import AccessProfile +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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 + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =AccessProfilesApi(api_client).patch_access_profile(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-access-profiles-in-bulk +Update Access Profile(s) requestable field. +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. +A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-access-profiles-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile_bulk_update_request_inner | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | True | + +### Return type +[**List[AccessProfileUpdateItem]**](../models/access-profile-update-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | List of updated and not updated Access Profiles. | List[AccessProfileUpdateItem] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +412 | Precondition Failed - Returned in response if API/Feature not enabled for an organization. | UpdateAccessProfilesInBulk412Response | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner +from sailpoint.beta.models.access_profile_update_item import AccessProfileUpdateItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + 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() + new_access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + results =AccessProfilesApi(api_client).update_access_profiles_in_bulk(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(new_access_profile_bulk_update_request_inner) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md new file mode 100644 index 000000000..8fe344ea9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md @@ -0,0 +1,449 @@ +--- +id: beta-access-request-approvals +title: Access_Request_Approvals +pagination_label: Access_Request_Approvals +sidebar_label: Access_Request_Approvals +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Request_Approvals', 'BetaAccess_Request_Approvals'] +slug: /tools/sdk/python/beta/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'Access_Request_Approvals', 'BetaAccess_Request_Approvals'] +--- + +# sailpoint.beta.AccessRequestApprovalsApi + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-completed-approvals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | comment_dto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.comment_dto import CommentDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + + try: + # Approve Access Request Approval + new_comment_dto = CommentDto() + new_comment_dto.from_json(comment_dto) + results =AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | forward_approval_dto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.forward_approval_dto import ForwardApprovalDto +from pprint import pprint +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" : "newOwnerId", + "comment" : "comment" + } # ForwardApprovalDto | Information about the forwarded approval. + + try: + # Forward Access Request Approval + new_forward_approval_dto = ForwardApprovalDto() + new_forward_approval_dto.from_json(forward_approval_dto) + results =AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-approval-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + Query | from_date | **str** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + +### Return type +[**ApprovalSummary**](../models/approval-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary | - | +400 | Client Error - Returned if the query parameter is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.approval_summary import ApprovalSummary +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-completed-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + 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, 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* + 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: **created, modified** + +### Return type +[**List[CompletedApproval]**](../models/completed-approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Completed Approvals. | List[CompletedApproval] | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.completed_approval import CompletedApproval +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + owner_id = 'owner_id_example' # 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 = '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: **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 = '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: **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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-pending-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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: **created, modified** + +### Return type +[**List[PendingApproval]**](../models/pending-approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Pending Approvals. | List[PendingApproval] | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.pending_approval import PendingApproval +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + owner_id = 'owner_id_example' # 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 = '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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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* (optional) + 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: **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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | comment_dto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.comment_dto import CommentDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + + try: + # Reject Access Request Approval + new_comment_dto = CommentDto() + new_comment_dto.from_json(comment_dto) + results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md new file mode 100644 index 000000000..a625edb57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md @@ -0,0 +1,88 @@ +--- +id: beta-access-request-identity-metrics +title: Access_Request_Identity_Metrics +pagination_label: Access_Request_Identity_Metrics +sidebar_label: Access_Request_Identity_Metrics +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Request_Identity_Metrics', 'BetaAccess_Request_Identity_Metrics'] +slug: /tools/sdk/python/beta/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'Access_Request_Identity_Metrics', 'BetaAccess_Request_Identity_Metrics'] +--- + +# sailpoint.beta.AccessRequestIdentityMetricsApi + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-request-identity-metrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + + +## get-access-request-identity-metrics +Return access request identity metrics +Use this API to return information access metrics. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-identity-metrics) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Manager's identity ID. +Path | requested_object_id | **str** | True | Requested access item's ID. +Path | type | **str** | True | Requested access item's type. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of the resource access and source activity for the direct reports of the provided manager. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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, requested_object_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md new file mode 100644 index 000000000..94a75512a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md @@ -0,0 +1,546 @@ +--- +id: beta-access-requests +title: Access_Requests +pagination_label: Access_Requests +sidebar_label: Access_Requests +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Requests', 'BetaAccess_Requests'] +slug: /tools/sdk/python/beta/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'Access_Requests', 'BetaAccess_Requests'] +--- + +# sailpoint.beta.AccessRequestsApi + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request +[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request +[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status +[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | cancel_access_request | [**CancelAccessRequest**](../models/cancel-access-request) | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.cancel_access_request import CancelAccessRequest +from pprint import pprint +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() + new_cancel_access_request.from_json(cancel_access_request) + results =AccessRequestsApi(api_client).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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## close-access-request +Close Access Request +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/close-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | close_access_request | [**CloseAccessRequest**](../models/close-access-request) | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.close_access_request import CloseAccessRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_close_access_request.from_json(close_access_request) + results =AccessRequestsApi(api_client).close_access_request(new_close_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).close_access_request(new_close_access_request) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. +These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request | [**AccessRequest**](../models/access-request) | True | + +### Return type +[**AccessRequestResponse**](../models/access-request-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Access Request Response. | AccessRequestResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request import AccessRequest +from sailpoint.beta.models.access_request_response import AccessRequestResponse +from pprint import pprint +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() + new_access_request.from_json(access_request) + results =AccessRequestsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Access Request Configuration Details. | AccessRequestConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_config import AccessRequestConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-request-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + Query | assigned_to | **str** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | count | **bool** | (optional) (default to False) | 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. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. + Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, 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: **created, modified, accountActivityItemId, name** + Query | request_state | **str** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**List[RequestedItemStatus]**](../models/requested-item-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of requested item statuses. | List[RequestedItemStatus] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.requested_item_status import RequestedItemStatus +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-access-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_config | [**AccessRequestConfig**](../models/access-request-config) | True | + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Access Request Configuration Details. | AccessRequestConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_config import AccessRequestConfig +from pprint import pprint +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() + new_access_request_config.from_json(access_request_config) + results =AccessRequestsApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md new file mode 100644 index 000000000..f776b7697 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md @@ -0,0 +1,191 @@ +--- +id: beta-account-activities +title: Account_Activities +pagination_label: Account_Activities +sidebar_label: Account_Activities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Activities', 'BetaAccount_Activities'] +slug: /tools/sdk/python/beta/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'Account_Activities', 'BetaAccount_Activities'] +--- + +# sailpoint.beta.AccountActivitiesApi + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes that occur on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity +[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + + +## get-account-activity +Get Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-activity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account activity id + +### Return type +[**CancelableAccountActivity**](../models/cancelable-account-activity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An account activity object | CancelableAccountActivity | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.account_activities_api import AccountActivitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity +from pprint import pprint +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 Account Activity + + results =AccountActivitiesApi(api_client).get_account_activity(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") + pprint(results) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-account-activities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + Query | type | **str** | (optional) | The type of account activity. + 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: **type**: *eq, in, ge, gt, 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* + 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: **type, created, modified** + +### Return type +[**List[CancelableAccountActivity]**](../models/cancelable-account-activity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of account activities | List[CancelableAccountActivity] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.account_activities_api import AccountActivitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + requested_for = 'requested_for_example' # 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 = 'requested_by_example' # 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 = 'regarding_identity_example' # 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) + type = 'type_example' # str | The type of account activity. (optional) # str | The type of account activity. (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 = '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: **type**: *eq, in, ge, gt, 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, gt, 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 = '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: **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, type, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md new file mode 100644 index 000000000..084e470ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md @@ -0,0 +1,99 @@ +--- +id: beta-account-aggregations +title: Account_Aggregations +pagination_label: Account_Aggregations +sidebar_label: Account_Aggregations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Aggregations', 'BetaAccount_Aggregations'] +slug: /tools/sdk/python/beta/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'Account_Aggregations', 'BetaAccount_Aggregations'] +--- + +# sailpoint.beta.AccountAggregationsApi + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-aggregation-status**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + + +## get-account-aggregation-status +In-progress Account Aggregation status +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-aggregation-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account aggregation id + +### Return type +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An account aggregation status object | AccountAggregationStatus | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.account_aggregations_api import AccountAggregationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_aggregation_status import AccountAggregationStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id + + try: + # In-progress Account Aggregation status + + results =AccountAggregationsApi(api_client).get_account_aggregation_status(id) + # Below is a request that includes all optional parameters + # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md new file mode 100644 index 000000000..3b0c9b97b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md @@ -0,0 +1,92 @@ +--- +id: beta-account-usages +title: Account_Usages +pagination_label: Account_Usages +sidebar_label: Account_Usages +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Usages', 'BetaAccount_Usages'] +slug: /tools/sdk/python/beta/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'Account_Usages', 'BetaAccount_Usages'] +--- + +# sailpoint.beta.AccountUsagesApi + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-usages-by-account-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | account_id | **str** | True | ID of IDN account + 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 | 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: **date** + +### Return type +[**List[AccountUsage]**](../models/account-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of account usage insights for past 12 months. | List[AccountUsage] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.account_usages_api import AccountUsagesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_usage import AccountUsage +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md new file mode 100644 index 000000000..c2e65b5d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md @@ -0,0 +1,1136 @@ +--- +id: beta-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Accounts', 'BetaAccounts'] +slug: /tools/sdk/python/beta/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'BetaAccounts'] +--- + +# sailpoint.beta.AccountsApi + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **POST** `/accounts` | Create Account +[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account +[**delete-account-async**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account +[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account +[**disable-account-for-identity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account +[**enable-account-for-identity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts List +[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + + +## create-account +Create Account +Submits an account creation task - the API then returns the task ID. + +The `sourceId` where this account will be created must be included in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | account_attributes_create | [**AccountAttributesCreate**](../models/account-attributes-create) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_attributes_create import AccountAttributesCreate +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_attributes_create.from_json(account_attributes_create) + results =AccountsApi(api_client).create_account(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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-account +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +>**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-account-async +Remove Account +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. Returns task result details of removal request. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_result_dto import TaskResultDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id + + try: + # Remove Account + + results =AccountsApi(api_client).delete_account_async(id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account_async(id) + print("The response of AccountsApi->delete_account_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-account +Disable Account +This API submits a task to disable the account and returns the task ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + Body | account_toggle_request | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_toggle_request import AccountToggleRequest +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_toggle_request.from_json(account_toggle_request) + results =AccountsApi(api_client).disable_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-account-for-identity +Disable IDN Account for Identity +This API submits a task to disable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + + try: + # Disable IDN Account for Identity + + results =AccountsApi(api_client).disable_account_for_identity(id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account_for_identity(id) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-accounts-for-identities +Disable IDN Accounts for Identities +This API submits tasks to disable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identities_accounts_bulk_request | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**List[BulkIdentitiesAccountsResponse]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | Bulk response details. | List[BulkIdentitiesAccountsResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse +from sailpoint.beta.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + + try: + # Disable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest() + new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + results =AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-account +Enable Account +This API submits a task to enable account and returns the task ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + Body | account_toggle_request | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_toggle_request import AccountToggleRequest +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_toggle_request.from_json(account_toggle_request) + results =AccountsApi(api_client).enable_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-account-for-identity +Enable IDN Account for Identity +This API submits a task to enable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + + try: + # Enable IDN Account for Identity + + results =AccountsApi(api_client).enable_account_for_identity(id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account_for_identity(id) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-accounts-for-identities +Enable IDN Accounts for Identities +This API submits tasks to enable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identities_accounts_bulk_request | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**List[BulkIdentitiesAccountsResponse]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | Bulk response details. | List[BulkIdentitiesAccountsResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse +from sailpoint.beta.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + + try: + # Enable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest() + new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + results =AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-account +Account Details +Use this API to return the details for a single account by its ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + +### Return type +[**Account**](../models/account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Account object. | Account | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account import Account +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-account-entitlements +Account Entitlements +This API returns entitlements of the account. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + 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[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An array of account 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + 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: + # Account Entitlements + + results =AccountsApi(api_client).get_account_entitlements(id, ) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-accounts +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | detail_level | **str** | (optional) | 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. + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **modified**: *eq, ge, gt, le, lt* + 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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** + +### Return type +[**List[Account]**](../models/account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of account objects. | List[Account] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account import Account +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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) + 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* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.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, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (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(detail_level, limit, offset, count, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-account +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + Body | account_attributes | [**AccountAttributes**](../models/account-attributes) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_attributes import AccountAttributes +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_attributes.from_json(account_attributes) + results =AccountsApi(api_client).put_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-reload-account +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reload-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## unlock-account +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/unlock-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account ID. + Body | account_unlock_request | [**AccountUnlockRequest**](../models/account-unlock-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.account_unlock_request import AccountUnlockRequest +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_unlock_request.from_json(account_unlock_request) + results =AccountsApi(api_client).unlock_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-account +Update Account +Use this API to update account details. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + Body | request_body | **[]object** | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # 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() + new_request_body.from_json(request_body) + results =AccountsApi(api_client).update_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md new file mode 100644 index 000000000..9672088e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md @@ -0,0 +1,334 @@ +--- +id: beta-application-discovery +title: Application_Discovery +pagination_label: Application_Discovery +sidebar_label: Application_Discovery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Application_Discovery', 'BetaApplication_Discovery'] +slug: /tools/sdk/python/beta/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'Application_Discovery', 'BetaApplication_Discovery'] +--- + +# sailpoint.beta.ApplicationDiscoveryApi + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-application-by-id**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get Discovered Application by ID +[**get-discovered-applications**](#get-discovered-applications) | **GET** `/discovered-applications` | Retrieve discovered applications for tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**patch-discovered-application-by-id**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-application-by-id +Get Discovered Application by ID +Get the discovered application, along with with its associated sources, based on the provided ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-discovered-application-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Discovered application's ID. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the discovered application, along with its associated sources. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + + try: + # Get Discovered Application by ID + + ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id) + # Below is a request that includes all optional parameters + # ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-discovered-applications +Retrieve discovered applications for tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-discovered-applications) + +### 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 | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + Query | filter | **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**: *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* + 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, description, discoveredAt, discoverySource** + +### Return type +[**List[GetDiscoveredApplications200ResponseInner]**](../models/get-discovered-applications200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | List[GetDiscoveredApplications200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner +from pprint import pprint +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: + # Retrieve 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") + pprint(results) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-manual-discover-applications-csv-template) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-discovered-application-by-id +Patch Discovered Application by ID +Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +You can patch these fields: - **associatedSources** - **dismissed** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-discovered-application-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Discovered application's ID. + Body | json_patch_operations | [**[]JsonPatchOperations**](../models/json-patch-operations) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the single patched discovered application. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operations import JsonPatchOperations +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + [{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional) + json_patch_operations = { + "op" : "replace", + "path" : "/dismissed", + "value" : true + } # List[JsonPatchOperations] | (optional) + + + try: + # Patch Discovered Application by ID + + ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id, ) + # Below is a request that includes all optional parameters + # ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id, new_json_patch_operations) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Upload a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-manual-discover-applications-csv-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | file | **bytearray** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The CSV has been successfully processed. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md new file mode 100644 index 000000000..fab87f4ab --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md @@ -0,0 +1,149 @@ +--- +id: beta-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Approvals', 'BetaApprovals'] +slug: /tools/sdk/python/beta/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'BetaApprovals'] +--- + +# sailpoint.beta.ApprovalsApi + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval +[**get-approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals + + +## get-approval +Get Approval +Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the approval that to be returned. + +### Return type +[**Approval**](../models/approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Approval object | Approval | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.approvals_api import ApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.approval import Approval +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned. + + try: + # Get Approval + + results =ApprovalsApi(api_client).get_approval(id) + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approval(id) + print("The response of ApprovalsApi->get_approval:\n") + pprint(results) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-approvals +Get Approvals +Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | mine | **bool** | (optional) | Returns the list of approvals for the current caller. + Query | requester_id | **str** | (optional) | Returns the list of approvals for a given requester ID. + 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: **status**: *eq* **referenceType**: *eq* + +### Return type +[**List[Approval]**](../models/approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of approvals. | List[Approval] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.approvals_api import ApprovalsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.approval import Approval +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(results) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md new file mode 100644 index 000000000..2854d8945 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md @@ -0,0 +1,968 @@ +--- +id: beta-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Apps', 'BetaApps'] +slug: /tools/sdk/python/beta/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'BetaApps'] +--- + +# sailpoint.beta.AppsApi + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-app**](#create-source-app) | **POST** `/source-apps` | Create source app +[**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**delete-source-app**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID +[**get-source-app**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID +[**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**list-all-source-app**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps +[**list-all-user-apps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps +[**list-assigned-source-app**](#list-assigned-source-app) | **GET** `/source-apps/assigned` | List assigned source apps +[**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**list-available-source-apps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps +[**list-owned-user-apps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps +[**patch-source-app**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID +[**patch-user-app**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID +[**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps + + +## create-source-app +Create source app +This endpoint creates a source app using the given source app payload + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | source_app_create_dto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True | + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app as created. | SourceApp | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app import SourceApp +from sailpoint.beta.models.source_app_create_dto import SourceAppCreateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_source_app_create_dto.from_json(source_app_create_dto) + results =AppsApi(api_client).create_source_app(new_source_app_create_dto) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).create_source_app(new_source_app_create_dto) + print("The response of AppsApi->create_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-profiles-from-source-app-by-bulk +Bulk remove access profiles from the specified source app +This API returns the final list of access profiles for the specified source app after removing + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-from-source-app-by-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app + Body | request_body | **[]str** | True | + 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. + +### Return type +[**List[AccessProfileDetails]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The final list of access profiles for the specified source app | List[AccessProfileDetails] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile_details import AccessProfileDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # 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() + new_request_body.from_json(request_body) + results =AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, 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, new_request_body, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-source-app +Delete source app by ID +Use this API to delete a specific source app + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | source app ID. + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app as deleted. | SourceApp | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. + + try: + # Delete source app by ID + + results =AppsApi(api_client).delete_source_app(id) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).delete_source_app(id) + print("The response of AppsApi->delete_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-app +Get source app by ID +This API returns a source app by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app. | SourceApp | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + + try: + # Get source app by ID + + results =AppsApi(api_client).get_source_app(id) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).get_source_app(id) + print("The response of AppsApi->get_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-profiles-for-source-app +List access profiles for the specified source app +This API returns the list of access profiles for the specified source app + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles-for-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app + 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: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**List[AccessProfileDetails]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access profiles for the specified source app | List[AccessProfileDetails] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_profile_details import AccessProfileDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + 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, ) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_access_profiles_for_source_app(id, limit, offset, filters) + print("The response of AppsApi->list_access_profiles_for_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-all-source-app +List all source apps +This API returns the list of all source apps for the org. + +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-source-app) + +### 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 | 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 | 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 | 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, owner.id, accountSource.id** + 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* + +### Return type +[**List[SourceApp]**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of source apps | List[SourceApp] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app import SourceApp +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-all-user-apps +List all user apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-user-apps) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | filters | **str** | True | Filter results using the standard syntax described in [V3 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* + 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 | 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[UserApp]**](../models/user-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of user apps | List[UserApp] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.user_app import UserApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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* + 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, ) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-assigned-source-app +List assigned source apps +This API returns the list of source apps assigned for logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-assigned-source-app) + +### 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 | 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 | 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 | 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, accountSource.id** + 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**List[SourceApp]**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of source apps | List[SourceApp] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app import SourceApp +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-available-accounts-for-user-app +List available accounts for user app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-accounts-for-user-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the user app + 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 | 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[AppAccountDetails]**](../models/app-account-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of available accounts for the specified user app | List[AppAccountDetails] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.app_account_details import AppAccountDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app + 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 available accounts for user app + + results =AppsApi(api_client).list_available_accounts_for_user_app(id, ) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset) + print("The response of AppsApi->list_available_accounts_for_user_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-available-source-apps +List available source apps +This API returns the list of source apps available for access request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-source-apps) + +### 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 | 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 | 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 | 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, owner.id, accountSource.id** + 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**List[SourceApp]**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of source apps | List[SourceApp] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app import SourceApp +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-owned-user-apps +List owned user apps +This API returns the list of user apps assigned to logged in user + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-owned-user-apps) + +### 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 | 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 | 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: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + +### Return type +[**List[UserApp]**](../models/user-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of user apps | List[UserApp] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.user_app import UserApp +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-source-app +Patch source app by ID +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app as updated. | SourceAppPatchDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.source_app_patch_dto import SourceAppPatchDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch source app by ID + + results =AppsApi(api_client).patch_source_app(id, ) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).patch_source_app(id, new_json_patch_operation) + print("The response of AppsApi->patch_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-user-app +Patch user app by ID +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-user-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the user app to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**UserApp**](../models/user-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the user app as updated. | UserApp | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.user_app import UserApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch user app by ID + + results =AppsApi(api_client).patch_user_app(id, ) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).patch_user_app(id, new_json_patch_operation) + print("The response of AppsApi->patch_user_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-apps-in-bulk +Bulk update source apps +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-apps-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | source_app_bulk_update_request | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) | + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # AppsApi(api_client).update_source_apps_in_bulk(new_source_app_bulk_update_request) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md new file mode 100644 index 000000000..f25b5e3d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md @@ -0,0 +1,215 @@ +--- +id: beta-auth-profile +title: Auth_Profile +pagination_label: Auth_Profile +sidebar_label: Auth_Profile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Auth_Profile', 'BetaAuth_Profile'] +slug: /tools/sdk/python/beta/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'Auth_Profile', 'BetaAuth_Profile'] +--- + +# sailpoint.beta.AuthProfileApi + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-profile-config**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile. +[**get-profile-config-list**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles. +[**patch-profile-config**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile + + +## get-profile-config +Get Auth Profile. +This API returns auth profile information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Auth Profile to get. + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Profile | AuthProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.auth_profile_api import AuthProfileApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.auth_profile import AuthProfile +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get. + + try: + # Get Auth Profile. + + results =AuthProfileApi(api_client).get_profile_config(id) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config(id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-profile-config-list +Get list of Auth Profiles. +This API returns a list of auth profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config-list) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[AuthProfileSummary]**](../models/auth-profile-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Auth Profiles | List[AuthProfileSummary] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.auth_profile_api import AuthProfileApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.auth_profile_summary import AuthProfileSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get list of Auth Profiles. + + results =AuthProfileApi(api_client).get_profile_config_list() + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config_list() + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-profile-config +Patch a specified Auth Profile +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-profile-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Auth Profile to patch. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Auth Profile as updated. | AuthProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.auth_profile_api import AuthProfileApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.auth_profile import AuthProfile +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Auth Profile + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =AuthProfileApi(api_client).patch_profile_config(id, new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).patch_profile_config(id, new_json_patch_operation) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md new file mode 100644 index 000000000..2627a70d2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md @@ -0,0 +1,1878 @@ +--- +id: beta-certification-campaigns +title: Certification_Campaigns +pagination_label: Certification_Campaigns +sidebar_label: Certification_Campaigns +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Campaigns', 'BetaCertification_Campaigns'] +slug: /tools/sdk/python/beta/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'Certification_Campaigns', 'BetaCertification_Campaigns'] +--- + +# sailpoint.beta.CertificationCampaignsApi + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **POST** `/campaigns` | Create Campaign +[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Campaign ID. + Body | complete_campaign_options | [**CompleteCampaignOptions**](../models/complete-campaign-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.complete_campaign_options import CompleteCampaignOptions +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. + complete_campaign_options = { + "autoCompleteAction" : "REVOKE" + } # CompleteCampaignOptions | 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, ) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_complete_campaign_options) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Create Campaign +Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign | [**Campaign**](../models/campaign) | True | + +### Return type +[**Campaign**](../models/campaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign import Campaign +from pprint import pprint +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 Campaign + new_campaign = Campaign() + new_campaign.from_json(campaign) + results =CertificationCampaignsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Create a Campaign Template +Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_template | [**CampaignTemplate**](../models/campaign-template) | True | + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignTemplate | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_template import CampaignTemplate +from pprint import pprint +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() + new_campaign_template.from_json(campaign_template) + results =CertificationCampaignsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being deleted. + +### 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 | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template whose schedule is being deleted. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-campaigns +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaigns) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | delete_campaigns_request | [**DeleteCampaignsRequest**](../models/delete-campaigns-request) | True | IDs of the campaigns to delete. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.delete_campaigns_request import DeleteCampaignsRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + delete_campaigns_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # DeleteCampaignsRequest | IDs of the campaigns to delete. + + try: + # Delete Campaigns + new_delete_campaigns_request = DeleteCampaignsRequest() + new_delete_campaigns_request.from_json(delete_campaigns_request) + results =CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_request) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_request) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-active-campaigns +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List Campaigns +Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-active-campaigns) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + 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, sw* **status**: *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, created** + +### Return type +[**List[GetActiveCampaigns200ResponseInner]**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of campaign objects. By default, the API returns a list of SLIM campaigns. | List[GetActiveCampaigns200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign to be retrieved. + +### Return type +[**Slimcampaign**](../models/slimcampaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Campaign object. | Slimcampaign | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.slimcampaign import Slimcampaign +from pprint import pprint +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. + + try: + # Get Campaign + + results =CertificationCampaignsApi(api_client).get_campaign(id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign(id) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-reports +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign whose reports are being fetched. + +### Return type +[**List[CampaignReport]**](../models/campaign-report) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Array of campaign report objects. | List[CampaignReport] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_report import CampaignReport +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-reports-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Campaign report configuration. | CampaignReportsConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Requested campaign template's ID. + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Data for the campaign matching the given ID. | CampaignTemplate | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_template import CampaignTemplate +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template whose schedule is being fetched. + +### Return type +[**Schedule**](../models/schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule) for more examples. | Schedule | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.schedule import Schedule +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-templates +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates). + +The endpoint returns all campaign templates matching the query parameters. + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-templates) + +### 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 | 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 | 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**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + +### Return type +[**List[CampaignTemplate]**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of campaign template objects. | List[CampaignTemplate] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_template import CampaignTemplate +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +``` + + + +[[Back to top]](#) + +## move +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Reassign Certifications +This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/move) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification campaign ID + Body | admin_review_reassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The reassign task that has been submitted. | CertificationTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.admin_review_reassign import AdminReviewReassign +from sailpoint.beta.models.certification_task import CertificationTask +from pprint import pprint +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() + new_admin_review_reassign.from_json(admin_review_reassign) + results =CertificationCampaignsApi(api_client).move(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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) + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_template import CampaignTemplate +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =CertificationCampaignsApi(api_client).patch_campaign_template(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-campaign-reports-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-reports-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_reports_config | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted campaign report configuration. | CampaignReportsConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig +from pprint import pprint +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() + new_campaign_reports_config.from_json(campaign_reports_config) + results =CertificationCampaignsApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. +Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being scheduled. + Body | schedule | [**Schedule**](../models/schedule) | (optional) | + +### 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. | ListAccessModelMetadataAttribute401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +400 | Client Error - Returned if the request body is invalid. | 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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.schedule import Schedule +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## start-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Campaign ID. + Body | activate_campaign_options | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | 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. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.activate_campaign_options import ActivateCampaignOptions +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-campaign-remediation-scan +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-remediation-scan) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign the remediation scan is being run for. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-campaign-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Run Campaign Report +Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign the report is being run for. +Path | type | [**ReportType**](../models/report-type) | True | Type of report to run. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.report_type import ReportType +from pprint import pprint +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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of report to run. + + try: + # Run Campaign Report + + results =CertificationCampaignsApi(api_client).start_campaign_report(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-generate-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + +Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-generate-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template to use for generation. + +### Return type +[**CampaignReference**](../models/campaign-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.campaign_reference import CampaignReference +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign being modified. + Body | request_body | **[]object** | True | 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 + +### Return type +[**Slimcampaign**](../models/slimcampaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | Slimcampaign | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.slimcampaign import Slimcampaign +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign being modified. # str | ID of the campaign being modified. + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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_request_body = RequestBody() + new_request_body.from_json(request_body) + results =CertificationCampaignsApi(api_client).update_campaign(id, new_request_body) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).update_campaign(id, new_request_body) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md new file mode 100644 index 000000000..45cd604c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md @@ -0,0 +1,456 @@ +--- +id: beta-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certifications', 'BetaCertifications'] +slug: /tools/sdk/python/beta/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'BetaCertifications'] +--- + +# sailpoint.beta.CertificationsApi + Use this API to implement certification functionality. +This API provides specific functionality that improves an organization's ability to manage its certification process. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +This API enables administrators and reviewers to get useful information about certifications at a high level, such as the reviewers involved, and at a more granular level, such as the permissions affected by changes to entitlements within those certifications. +It also provides the useful ability to reassign identities and items within certifications to other reviewers, rather than [reassigning the entire certifications themselves](https://developer.sailpoint.com/idn/api/beta/submit-reassign-certs-async/). + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks +[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status +[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-certifications**](#list-certifications) | **GET** `/certifications` | Certifications by IDs +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-identity-certification-item-permissions +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-item-permissions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | certification_id | **str** | True | The certification ID +Path | item_id | **str** | True | The certification item ID + 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: **target**: *eq, sw* **rights**: *ca* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` + 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[PermissionDto]**](../models/permission-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of permissions associated with the given itemId | List[PermissionDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.permission_dto import PermissionDto +from pprint import pprint +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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-certification-pending-tasks +Pending Certification Tasks +This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-pending-tasks) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + +### Return type +[**List[IdentityCertificationTask]**](../models/identity-certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects. | List[IdentityCertificationTask] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + + try: + # Pending Certification Tasks + + results =CertificationsApi(api_client).get_identity_certification_pending_tasks(id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) + print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-certification-task-status +Certification Task Status +This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-task-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID +Path | task_id | **str** | True | The certification task ID + +### Return type +[**IdentityCertificationTask**](../models/identity-certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A certification task object. | IdentityCertificationTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID + + try: + # Certification Task Status + + results =CertificationsApi(api_client).get_identity_certification_task_status(id, task_id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification_task_status(id, task_id) + print("The response of CertificationsApi->get_identity_certification_task_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-certification-reviewers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List of Reviewers for certification +This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certification-reviewers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification ID + 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, sw* **email**: *eq, 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, email** + +### Return type +[**List[IdentityReferenceWithNameAndEmail]**](../models/identity-reference-with-name-and-email) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of reviewers | List[IdentityReferenceWithNameAndEmail] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-certifications +Certifications by IDs +This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certifications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | reviewer_identitiy | **str** | (optional) | The ID of reviewer identity. *me* indicates the current user. + 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.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, due, signed** + +### Return type +[**List[CertificationDto]**](../models/certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of certifications | List[CertificationDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.certification_dto import CertificationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + reviewer_identitiy = 'reviewer_identitiy_example' # 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 = '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: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + 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: **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: + # Certifications by IDs + + results =CertificationsApi(api_client).list_certifications() + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certifications:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-reassign-certs-async +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reassign-certs-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + Body | review_reassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**IdentityCertificationTask**](../models/identity-certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A certification task object for the reassignment which can be queried for status. | IdentityCertificationTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask +from sailpoint.beta.models.review_reassign import ReviewReassign +from pprint import pprint +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() + new_review_reassign.from_json(review_reassign) + results =CertificationsApi(api_client).submit_reassign_certs_async(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md new file mode 100644 index 000000000..0e4e0c611 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md @@ -0,0 +1,450 @@ +--- +id: beta-connector-rule-management +title: Connector_Rule_Management +pagination_label: Connector_Rule_Management +sidebar_label: Connector_Rule_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Connector_Rule_Management', 'BetaConnector_Rule_Management'] +slug: /tools/sdk/python/beta/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'Connector_Rule_Management', 'BetaConnector_Rule_Management'] +--- + +# sailpoint.beta.ConnectorRuleManagementApi + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-rule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule +[**delete-connector-rule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a Connector-Rule +[**get-connector-rule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-Rule by ID +[**get-connector-rule-list**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules +[**update-connector-rule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule +[**validate-connector-rule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule + + +## create-connector-rule +Create Connector Rule +Creates a new connector rule. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | connector_rule_create_request | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | The connector rule to create + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The created connector rule | ConnectorRuleResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.connector_rule_create_request import ConnectorRuleCreateRequest +from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | The connector rule to create + + try: + # Create Connector Rule + new_connector_rule_create_request = ConnectorRuleCreateRequest() + new_connector_rule_create_request.from_json(connector_rule_create_request) + results =ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-connector-rule +Delete a Connector-Rule +Deletes the connector rule specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the connector rule 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete # str | ID of the connector rule to delete + + try: + # Delete a Connector-Rule + + ConnectorRuleManagementApi(api_client).delete_connector_rule(id) + # Below is a request that includes all optional parameters + # ConnectorRuleManagementApi(api_client).delete_connector_rule(id) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-rule +Connector-Rule by ID +Returns the connector rule specified by ID. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the connector rule to retrieve + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Connector rule with the given ID | ConnectorRuleResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve + + try: + # Connector-Rule by ID + + results =ConnectorRuleManagementApi(api_client).get_connector_rule(id) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-rule-list +List Connector Rules +Returns the list of connector rules. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule-list) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[ConnectorRuleResponse]**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of connector rules | List[ConnectorRuleResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Connector Rules + + results =ConnectorRuleManagementApi(api_client).get_connector_rule_list() + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-connector-rule +Update a Connector Rule +Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the connector rule to update + Body | connector_rule_update_request | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | The connector rule with updated data + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The updated connector rule | ConnectorRuleResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse +from sailpoint.beta.models.connector_rule_update_request import ConnectorRuleUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + + try: + # Update a Connector Rule + + results =ConnectorRuleManagementApi(api_client).update_connector_rule(id, ) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).update_connector_rule(id, new_connector_rule_update_request) + print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## validate-connector-rule +Validate Connector Rule +Returns a list of issues within the code to fix, if any. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/validate-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | source_code | [**SourceCode**](../models/source-code) | True | The code to validate + +### Return type +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The status of the code's eligibility as a connector rule | ConnectorRuleValidationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.connector_rule_validation_response import ConnectorRuleValidationResponse +from sailpoint.beta.models.source_code import SourceCode +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | The code to validate + + try: + # Validate Connector Rule + new_source_code = SourceCode() + new_source_code.from_json(source_code) + results =ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code) + print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md new file mode 100644 index 000000000..c956ff5be --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md @@ -0,0 +1,104 @@ +--- +id: beta-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Connectors', 'BetaConnectors'] +slug: /tools/sdk/python/beta/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'BetaConnectors'] +--- + +# sailpoint.beta.ConnectorsApi + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get Connector List + + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-list) + +### 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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* + 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 | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**List[V3ConnectorDto]**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | List[V3ConnectorDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.connectors_api import ConnectorsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.v3_connector_dto import V3ConnectorDto +from pprint import pprint +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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md new file mode 100644 index 000000000..a929cb77d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md @@ -0,0 +1,1484 @@ +--- +id: beta-custom-forms +title: Custom_Forms +pagination_label: Custom_Forms +sidebar_label: Custom_Forms +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Custom_Forms', 'BetaCustom_Forms'] +slug: /tools/sdk/python/beta/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'Custom_Forms', 'BetaCustom_Forms'] +--- + +# sailpoint.beta.CustomFormsApi + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-form-definition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. +[**create-form-definition-by-template**](#create-form-definition-by-template) | **POST** `/form-definitions/template` | Create a form definition by template. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-file-request**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**create-form-instance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. +[**delete-form-definition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. +[**get-file-from-s3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-form-definition-by-key**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**get-form-instance-by-key**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. +[**get-form-instance-file**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**import-form-definitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. +[**patch-form-definition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**patch-form-instance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. +[**search-form-definitions-by-tenant**](#search-form-definitions-by-tenant) | **GET** `/form-definitions` | Export form definitions by tenant. +[**search-form-element-data-by-element-id**](#search-form-element-data-by-element-id) | **GET** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**search-form-instances-by-tenant**](#search-form-instances-by-tenant) | **GET** `/form-instances` | List form instances by tenant. +[**search-pre-defined-select-options**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. +[**show-preview-data-source**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + + +## create-form-definition +Creates a form definition. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_form_definition_request | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form definition | FormDefinitionResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest +from sailpoint.beta.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + create_form_definition_request = { + "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_create_form_definition_request) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-definition-by-template +Create a form definition by template. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-by-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_form_definition_request | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form definition | FormDefinitionResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest +from sailpoint.beta.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + create_form_definition_request = { + "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: + # Create a form definition by template. + + results =CustomFormsApi(api_client).create_form_definition_by_template() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition_by_template(new_create_form_definition_request) + print("The response of CustomFormsApi->create_form_definition_by_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-definition-dynamic-schema +Generate JSON Schema dynamically. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-dynamic-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a form elements dynamic schema | FormDefinitionDynamicSchemaResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest +from sailpoint.beta.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-definition-file-request +Upload new form definition file. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-file-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | FormDefinitionID String specifying FormDefinitionID + | file | **bytearray** | True | File specifying the multipart + +### Return type +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form definition file | FormDefinitionFileUploadResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +413 | An error with payload size too large | GetFormDefinitionByKey400Response | - | +415 | An error with unsupported media type | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | +503 | An external service is not available | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-instance +Creates a form instance. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-instance) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form instance | FormInstanceResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.create_form_instance_request import CreateFormInstanceRequest +from sailpoint.beta.models.form_instance_response import FormInstanceResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-form-definition +Deletes a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-form-definition) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Returns an empty body | object | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-form-definitions-by-tenant +List form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-form-definitions-by-tenant) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | offset | **int** | (optional) (default to 0) | 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. + Query | limit | **int** | (optional) (default to 250) | 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. + 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**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | sorters | **str** | (optional) (default to 'name') | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**List[ExportFormDefinitionsByTenant200ResponseInner]**](../models/export-form-definitions-by-tenant200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of form definition objects by tenant used by SP-Config | List[ExportFormDefinitionsByTenant200ResponseInner] | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-file-from-s3 +Download definition file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-file-from-s3) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | FormDefinitionID Form definition ID +Path | file_id | **str** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | bytearray | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | +503 | An external service is not available | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-form-definition-by-key +Return a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-definition-by-key) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a form definition | FormDefinitionResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-form-instance-by-key +Returns a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-by-key) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | Form instance ID + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a form instance by its key | FormInstanceResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_instance_response import FormInstanceResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-form-instance-file +Download instance file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-file) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | FormInstanceID Form instance ID +Path | file_id | **str** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a file that is referred to by fileID and associated with the formInstanceID | bytearray | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | +503 | An external service is not available | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-form-definitions +Import form definitions from export. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-form-definitions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions + +### Return type +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returns statuses of those form definition objects imported | ImportFormDefinitions202Response | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.import_form_definitions202_response import ImportFormDefinitions202Response +from sailpoint.beta.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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) + 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-form-definition +Patch a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-definition) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + Body | body | **[]Dict[str, object]** | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the form definition updated | FormDefinitionResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +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) + 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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-form-instance +Patch a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-instance) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | Form instance ID + Body | body | **[]Dict[str, object]** | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the form instance updated | FormInstanceResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +409 | An error with the request property conflicts with stored | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_instance_response import FormInstanceResponse +from pprint import pprint +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) + 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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-form-definitions-by-tenant +Export form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-definitions-by-tenant) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | offset | **int** | (optional) (default to 0) | 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. + Query | limit | **int** | (optional) (default to 250) | 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. + 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**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | sorters | **str** | (optional) (default to 'name') | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of form definitions by tenant | ListFormDefinitionsByTenantResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-form-element-data-by-element-id +Retrieves dynamic data by element. +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-element-data-by-element-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | Form instance ID +Path | form_element_id | **str** | True | Form element ID + Query | limit | **int** | (optional) (default to 250) | 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. + 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: **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\")` + Query | query | **str** | (optional) | 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. + +### Return type +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration | ListFormElementDataByElementIDResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse +from pprint import pprint +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_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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-form-instances-by-tenant +List form instances by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-instances-by-tenant) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[FormInstanceResponse]**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of form instances by tenant | List[FormInstanceResponse] | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_instance_response import FormInstanceResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-pre-defined-select-options +List predefined select options. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-pre-defined-select-options) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of available predefined select options | ListPredefinedSelectOptionsResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) +``` + + + +[[Back to top]](#) + +## show-preview-data-source +Preview form definition data source. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/show-preview-data-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + Query | limit | **int** | (optional) (default to 10) | 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. + 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: **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\")` + Query | query | **str** | (optional) | 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. + Body | form_element_preview_request | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a preview of a form definition data source | PreviewDataSourceResponse | - | +400 | An error with the request occurred | GetFormDefinitionByKey400Response | - | +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response | - | +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response | - | +404 | An error with the item not found | GetFormDefinitionByKey400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | GetFormDefinitionByKey400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.form_element_preview_request import FormElementPreviewRequest +from sailpoint.beta.models.preview_data_source_response import PreviewDataSourceResponse +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md new file mode 100644 index 000000000..ccde84d58 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md @@ -0,0 +1,214 @@ +--- +id: beta-custom-password-instructions +title: Custom_Password_Instructions +pagination_label: Custom_Password_Instructions +sidebar_label: Custom_Password_Instructions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Custom_Password_Instructions', 'BetaCustom_Password_Instructions'] +slug: /tools/sdk/python/beta/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'Custom_Password_Instructions', 'BetaCustom_Password_Instructions'] +--- + +# sailpoint.beta.CustomPasswordInstructionsApi + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/beta/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-password-instructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**get-custom-password-instructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + + +## create-custom-password-instructions +Create Custom Password Instructions +This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | custom_password_instruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True | + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the custom password instructions. | CustomPasswordInstruction | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.custom_password_instruction import CustomPasswordInstruction +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_custom_password_instruction.from_json(custom_password_instruction) + results =CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(new_custom_password_instruction) + # Below is a request that includes all optional parameters + # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(new_custom_password_instruction) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-custom-password-instructions +Delete Custom Password Instructions by page ID +This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-custom-password-instructions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | page_id | **str** | True | The page ID of custom password instructions to delete. + Query | locale | **str** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + +### 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + 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, ) + # Below is a request that includes all optional parameters + # CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, locale) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-custom-password-instructions +Get Custom Password Instructions by Page ID +This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-password-instructions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | page_id | **str** | True | The page ID of custom password instructions to query. + Query | locale | **str** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the custom password instructions. | CustomPasswordInstruction | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.custom_password_instruction import CustomPasswordInstruction +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + 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, ) + # Below is a request that includes all optional parameters + # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md new file mode 100644 index 000000000..bdbac91ec --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md @@ -0,0 +1,904 @@ +--- +id: beta-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Entitlements', 'BetaEntitlements'] +slug: /tools/sdk/python/beta/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'BetaEntitlements'] +--- + +# sailpoint.beta.EntitlementsApi + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +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. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**get-entitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement +[**get-entitlement-request-config**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**list-entitlement-children**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children +[**list-entitlement-parents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents +[**list-entitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. +[**patch-entitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement +[**put-entitlement-request-config**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**reset-source-entitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{sourceId}` | Reset Source Entitlements +[**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list + + +## create-access-model-metadata-for-entitlement +Add metadata to an entitlement. +Add single Access Model Metadata to an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-model-metadata-for-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The entitlement id. +Path | attribute_key | **str** | True | Technical name of the Attribute. +Path | attribute_value | **str** | True | Technical name of the Attribute Value. + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + + try: + # Add metadata to an entitlement. + + results =EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-model-metadata-from-entitlement +Remove metadata from an entitlement. +Remove single Access Model Metadata from an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-model-metadata-from-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The entitlement 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 | +------------- | ------------- | ------------- |------------------| +200 | OK | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + + try: + # Remove metadata from an entitlement. + + EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + # Below is a request that includes all optional parameters + # EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + except Exception as e: + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement +Get an entitlement +This API returns an entitlement by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The entitlement ID + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An entitlement | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID + + try: + # Get an entitlement + + results =EntitlementsApi(api_client).get_entitlement(id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement(id) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-request-config +Get Entitlement Request Config +This API returns the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement Id + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An Entitlement Request Config | EntitlementRequestConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id + + try: + # Get Entitlement Request Config + + results =EntitlementsApi(api_client).get_entitlement_request_config(id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement_request_config(id) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-entitlements-by-source +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Aggregate Entitlements +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-entitlements-by-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id + | csv_file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate. + +### Return type +[**LoadEntitlementTask**](../models/load-entitlement-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Aggregate Entitlements Task | LoadEntitlementTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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, ) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).import_entitlements_by_source(id, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-entitlement-children +List of entitlements children +This API returns a list of all child entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-children) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement Id + 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 | 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, type, attribute, value, source.id** + 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* **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* + +### Return type +[**List[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of entitlements children from an entitlement | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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 = '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, ) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-entitlement-parents +List of entitlements parents +This API returns a list of all parent entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-parents) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement Id + 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 | 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, type, attribute, value, source.id** + 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* **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* + +### Return type +[**List[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of entitlements parents from an entitlement | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement 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 = '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, ) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-entitlements +Gets a list of entitlements. +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | account_id | **str** | (optional) | 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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. + Query | segmented_for_identity | **str** | (optional) | 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. + Query | for_segment_ids | **str** | (optional) | 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). + Query | include_unsegmented | **bool** | (optional) (default to True) | 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. + 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: **id, name, created, modified, type, attribute, value, source.id, requestable** + 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* **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* + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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() + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlements:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-entitlement +Patch an entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the entitlement to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the entitlement as updated. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch an entitlement + + results =EntitlementsApi(api_client).patch_entitlement(id, ) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).patch_entitlement(id, new_json_patch_operation) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-entitlement-request-config +Replace Entitlement Request Config +This API replaces the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-entitlement-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement ID + Body | entitlement_request_config | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the entitlement request config as updated. | EntitlementRequestConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID + 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 + } + } # EntitlementRequestConfig | + + try: + # Replace Entitlement Request Config + new_entitlement_request_config = EntitlementRequestConfig() + new_entitlement_request_config.from_json(entitlement_request_config) + results =EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reset-source-entitlements +Reset Source Entitlements +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 [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-source-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of source for the entitlement reset + +### Return type +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Entitlement source reset task result | EntitlementSourceResetBaseReferenceDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset + + try: + # Reset Source Entitlements + + results =EntitlementsApi(api_client).reset_source_entitlements(source_id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).reset_source_entitlements(source_id) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-entitlements-in-bulk +Bulk update an entitlement list +This API applies an update to every entitlement of the list. + + +The number of entitlements to update is limited to 50 items maximum. + + +The JsonPatch update follows the [JSON +Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : +`**{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op": +"replace", "path": "/requestable","value": boolean }**` + + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | entitlement_bulk_update_request | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request) + # Below is a request that includes all optional parameters + # EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md new file mode 100644 index 000000000..b1746fff8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md @@ -0,0 +1,713 @@ +--- +id: beta-governance-groups +title: Governance_Groups +pagination_label: Governance_Groups +sidebar_label: Governance_Groups +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Governance_Groups', 'BetaGovernance_Groups'] +slug: /tools/sdk/python/beta/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'Governance_Groups', 'BetaGovernance_Groups'] +--- + +# sailpoint.beta.GovernanceGroupsApi + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. +[**delete-workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group +[**delete-workgroup-members**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**get-workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id +[**list-connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**list-workgroup-members**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**list-workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups +[**patch-workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group +[**update-workgroup-members**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + + +## create-workgroup +Create a new Governance Group. +This API creates a new Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | workgroup_dto | [**WorkgroupDto**](../models/workgroup-dto) | True | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Governance Group object created. | WorkgroupDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_workgroup_dto.from_json(workgroup_dto) + results =GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workgroup +Delete a Governance Group +This API deletes a Governance Group by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Governance Group + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + + try: + # Delete a Governance Group + + GovernanceGroupsApi(api_client).delete_workgroup(id) + # Below is a request that includes all optional parameters + # GovernanceGroupsApi(api_client).delete_workgroup(id) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workgroup-members +Remove members from Governance Group +This API removes one or more members from 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** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup-members) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + Body | bulk_workgroup_members_request_inner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be removed from a Governance Group members list. + +### Return type +[**List[WorkgroupMemberDeleteItem]**](../models/workgroup-member-delete-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | List of deleted and not deleted identities from Governance Group members list. | List[WorkgroupMemberDeleteItem] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner +from sailpoint.beta.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + + + try: + # Remove members from Governance Group + new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner() + new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + results =GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workgroups-in-bulk +Delete Governance Group(s) + +This API initiates a bulk deletion of one or more Governance Groups. + +> 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. + +> 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. + +> 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. + +> 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. + +> **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.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroups-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | workgroup_bulk_delete_request | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | True | + +### Return type +[**List[WorkgroupDeleteItem]**](../models/workgroup-delete-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | Governance Group bulk delete response. | List[WorkgroupDeleteItem] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest +from sailpoint.beta.models.workgroup_delete_item import WorkgroupDeleteItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + results =GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workgroup +Get Governance Group by Id +This API returns a Governance Groups by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Governance Group + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Governance Group | WorkgroupDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + + try: + # Get Governance Group by Id + + results =GovernanceGroupsApi(api_client).get_workgroup(id) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).get_workgroup(id) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-connections +List connections for Governance Group +This API returns list of connections associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-connections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + 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 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 | 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** + +### Return type +[**List[WorkgroupConnectionDto]**](../models/workgroup-connection-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List all connections associated with a Governance Group. | List[WorkgroupConnectionDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workgroup_connection_dto import WorkgroupConnectionDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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, ) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workgroup-members +List Governance Group Members +This API returns list of members associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroup-members) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + 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 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 | 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** + +### Return type +[**List[ListWorkgroupMembers200ResponseInner]**](../models/list-workgroup-members200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List all members associated with a Governance Group. | List[ListWorkgroupMembers200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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, ) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workgroups +List Governance Groups +This API returns list of Governance Groups + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroups) + +### 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 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 | 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *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, created, modified, id, description** + +### Return type +[**List[WorkgroupDto]**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Governance Groups | List[WorkgroupDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workgroup_dto import WorkgroupDto +from pprint import pprint +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 = 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() + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-workgroup +Patch a Governance Group +This API updates an existing governance group by ID. +The following fields and objects are patchable: + * name + * description + * owner + +A token with API or ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Governance Group + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Governance Group. | WorkgroupDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch a Governance Group + + results =GovernanceGroupsApi(api_client).patch_workgroup(id, ) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).patch_workgroup(id, new_json_patch_operation) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-workgroup-members +Add members to Governance Group +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** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workgroup-members) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + Body | bulk_workgroup_members_request_inner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be added to a Governance Group members list. + +### Return type +[**List[WorkgroupMemberAddItem]**](../models/workgroup-member-add-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | List of added and not added identities into Governance Group members list. | List[WorkgroupMemberAddItem] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner +from sailpoint.beta.models.workgroup_member_add_item import WorkgroupMemberAddItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + + + try: + # Add members to Governance Group + new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner() + new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + results =GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md new file mode 100644 index 000000000..ef368689f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md @@ -0,0 +1,571 @@ +--- +id: beta-iai-access-request-recommendations +title: IAI_Access_Request_Recommendations +pagination_label: IAI_Access_Request_Recommendations +sidebar_label: IAI_Access_Request_Recommendations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Access_Request_Recommendations', 'BetaIAI_Access_Request_Recommendations'] +slug: /tools/sdk/python/beta/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAI_Access_Request_Recommendations', 'BetaIAI_Access_Request_Recommendations'] +--- + +# sailpoint.beta.IAIAccessRequestRecommendationsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Notification of Ignored Access Request Recommendations +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Notification of Requested Access Request Recommendations +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk +[**get-access-request-recommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations + + +## add-access-request-recommendations-ignored-item +Notification of Ignored Access Request Recommendations +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-ignored-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_recommendation_action_item_dto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Recommendation successfully stored as ignored. | AccessRequestRecommendationActionItemResponseDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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: + # Notification of Ignored Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(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(new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## add-access-request-recommendations-requested-item +Notification of Requested Access Request Recommendations +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-requested-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_recommendation_action_item_dto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Notification successfully acknowledged. | AccessRequestRecommendationActionItemResponseDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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: + # Notification of Requested Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(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(new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-item +Notification of Viewed Access Request Recommendations +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_recommendation_action_item_dto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Recommendation successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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: + # Notification of Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(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(new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-items +Notification of Viewed Access Request Recommendations in Bulk +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_recommendation_action_item_dto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity. + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Recommendations successfully stored as viewed. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + + try: + # Notification of Viewed Access Request Recommendations in Bulk + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(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(new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations +Identity Access Request Recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | identity_id | **str** | (optional) (default to 'me') | Get access request recommendations for an identityId. *me* indicates the current user. + Query | limit | **int** | (optional) (default to 15) | Max number of results to return. + 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 | include_translation_messages | **bool** | (optional) (default to False) | If *true* it will populate a list of translation messages in the response. + 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + +### Return type +[**List[AccessRequestRecommendationItemDetail]**](../models/access-request-recommendation-item-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access request recommendations for the identityId | List[AccessRequestRecommendationItemDetail] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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 = '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: **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() + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-ignored-items +List of Ignored Access Request Recommendations +This API returns the list of ignored access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items) + +### 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id, access.type, identityId, timestamp** + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns list of ignored access request recommendations. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +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 = '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 of Ignored Access Request Recommendations + + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items() + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-requested-items +List of Requested Access Request Recommendations +This API returns a list of requested access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items) + +### 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id, access.type, identityId, timestamp** + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the list of requested access request recommendations. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +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 = '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 = '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: **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 of Requested Access Request Recommendations + + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items() + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-viewed-items +List of Viewed Access Request Recommendations +This API returns the list of viewed access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items) + +### 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id, access.type, identityId, timestamp** + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns list of viewed access request recommendations. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +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 = '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 = '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: **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 of Viewed Access Request Recommendations + + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items() + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md new file mode 100644 index 000000000..7528e03ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md @@ -0,0 +1,226 @@ +--- +id: beta-iai-common-access +title: IAI_Common_Access +pagination_label: IAI_Common_Access +sidebar_label: IAI_Common_Access +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Common_Access', 'BetaIAI_Common_Access'] +slug: /tools/sdk/python/beta/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAI_Common_Access', 'BetaIAI_Common_Access'] +--- + +# sailpoint.beta.IAICommonAccessApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-common-access**](#create-common-access) | **POST** `/common-access` | Create common access items +[**get-common-access**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access +[**update-common-access-status-in-bulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status + + +## create-common-access +Create common access items +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-common-access) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | common_access_item_request | [**CommonAccessItemRequest**](../models/common-access-item-request) | True | + +### Return type +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returns details of the common access classification request. | CommonAccessItemResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.common_access_item_request import CommonAccessItemRequest +from sailpoint.beta.models.common_access_item_response import CommonAccessItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_common_access_item_request.from_json(common_access_item_request) + results =IAICommonAccessApi(api_client).create_common_access(new_common_access_item_request) + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).create_common_access(new_common_access_item_request) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-common-access +Get a paginated list of common access +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 + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-common-access) + +### 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **access.name, status** By default the common access items are sorted by name, ascending. + +### Return type +[**List[CommonAccessResponse]**](../models/common-access-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of common access for a customer. | List[CommonAccessResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.common_access_response import CommonAccessResponse +from pprint import pprint +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 = '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() + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-common-access-status-in-bulk +Bulk update common access status +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-common-access-status-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | common_access_id_status | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | True | Confirm or deny in bulk the common access ids that are (or aren't) common access + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.common_access_id_status import CommonAccessIDStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # 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() + new_common_access_id_status.from_json(common_access_id_status) + results =IAICommonAccessApi(api_client).update_common_access_status_in_bulk(new_common_access_id_status) + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(new_common_access_id_status) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md new file mode 100644 index 000000000..2cf8da573 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md @@ -0,0 +1,81 @@ +--- +id: beta-iai-message-catalogs +title: IAI_Message_Catalogs +pagination_label: IAI_Message_Catalogs +sidebar_label: IAI_Message_Catalogs +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Message_Catalogs', 'BetaIAI_Message_Catalogs'] +slug: /tools/sdk/python/beta/methods/iai-message-catalogs +tags: ['SDK', 'Software Development Kit', 'IAI_Message_Catalogs', 'BetaIAI_Message_Catalogs'] +--- + +# sailpoint.beta.IAIMessageCatalogsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-message-catalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs + + +## get-message-catalogs +Get Message catalogs +The getMessageCatalogs API returns message catalog based on the language headers in the requested object. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-message-catalogs) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | catalog_id | **str** | True | The ID of the message catalog. + +### Return type +[**List[MessageCatalogDto]**](../models/message-catalog-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The message catalogs based on the request headers | List[MessageCatalogDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_message_catalogs_api import IAIMessageCatalogsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.message_catalog_dto import MessageCatalogDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog. + + try: + # Get Message catalogs + + results =IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) + # Below is a request that includes all optional parameters + # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) + print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md new file mode 100644 index 000000000..1c4b61dbb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md @@ -0,0 +1,617 @@ +--- +id: beta-iai-outliers +title: IAI_Outliers +pagination_label: IAI_Outliers +sidebar_label: IAI_Outliers +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Outliers', 'BetaIAI_Outliers'] +slug: /tools/sdk/python/beta/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAI_Outliers', 'BetaIAI_Outliers'] +--- + +# sailpoint.beta.IAIOutliersApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-outliers-zip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary +[**get-identity-outliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**ignore-identity-outliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore +[**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore + + +## export-outliers-zip +IAI Identity Outliers Export +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). + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-outliers-zip) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).export_outliers_zip(type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-outlier-snapshots +IAI Identity Outliers Summary +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outlier-snapshots) + +### 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 | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + 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: **snapshotDate**: *ge, le* + 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: **snapshotDate** + +### Return type +[**List[OutlierSummary]**](../models/outlier-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | List[OutlierSummary] | * X-Total-Count - The total result count. | +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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.outlier_summary import OutlierSummary +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-outliers +IAI Get Identity Outliers +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outliers) + +### 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 | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* + 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: **firstDetectionDate, attributes, score** + +### Return type +[**List[Outlier]**](../models/outlier) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object contains information about outliers. | List[Outlier] | * 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.outlier import Outlier +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-latest-identity-outlier-snapshots +IAI Identity Outliers Latest Summary +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-latest-identity-outlier-snapshots) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +[**List[LatestOutlierSummary]**](../models/latest-outlier-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | List[LatestOutlierSummary] | - | +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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.latest_outlier_summary import LatestOutlierSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-outlier-contributing-feature-summary +Get identity outlier contibuting feature summary +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-outlier-contributing-feature-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | outlier_feature_id | **str** | True | Contributing feature id + +### Return type +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns selected contributing feature summary for an outlier. | OutlierFeatureSummary | * accept-language - The locale to use for translations | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.outlier_feature_summary import OutlierFeatureSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id + + try: + # Get identity outlier contibuting feature summary + + results =IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-peer-group-outliers-contributing-features +Get identity outlier's contibuting features +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers-contributing-features) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | outlier_id | **str** | True | The outlier id + 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 | include_translation_messages | **str** | (optional) | Whether or not to include translation messages object in returned response + 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: **importance** + +### Return type +[**List[OutlierContributingFeature]**](../models/outlier-contributing-feature) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. | List[OutlierContributingFeature] | * X-Total-Count - The total result count. * accept-language - The locale to use for translations | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.outlier_contributing_feature import OutlierContributingFeature +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier 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) + 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, ) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) +``` + + + +[[Back to top]](#) + +## ignore-identity-outliers +IAI Identity Outliers Ignore +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/ignore-identity-outliers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + + try: + # IAI Identity Outliers Ignore + new_request_body = RequestBody() + new_request_body.from_json(request_body) + IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-outliers-contributing-feature-access-items +Gets a list of access items associated with each identity outlier contributing feature +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-outliers-contributing-feature-access-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | outlier_id | **str** | True | The outlier id +Path | contributing_feature_name | **str** | True | The name of contributing feature + 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 | access_type | **str** | (optional) | The type of access item for the identity outlier contributing feature. If not provided, it returns all. + 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: **displayName** + +### Return type +[**List[OutliersContributingFeatureAccessItems]**](../models/outliers-contributing-feature-access-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of access items. | List[OutliersContributingFeatureAccessItems] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, contributing_feature_name, ) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## un-ignore-identity-outliers +IAI Identity Outliers Unignore +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/un-ignore-identity-outliers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + + try: + # IAI Identity Outliers Unignore + new_request_body = RequestBody() + new_request_body.from_json(request_body) + IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md new file mode 100644 index 000000000..6dffe14c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md @@ -0,0 +1,90 @@ +--- +id: beta-iai-peer-group-strategies +title: IAI_Peer_Group_Strategies +pagination_label: IAI_Peer_Group_Strategies +sidebar_label: IAI_Peer_Group_Strategies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Peer_Group_Strategies', 'BetaIAI_Peer_Group_Strategies'] +slug: /tools/sdk/python/beta/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAI_Peer_Group_Strategies', 'BetaIAI_Peer_Group_Strategies'] +--- + +# sailpoint.beta.IAIPeerGroupStrategiesApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-peer-group-outliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + + +## get-peer-group-outliers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Identity Outliers List +-- 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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | strategy | **str** | True | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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[PeerGroupMember]**](../models/peer-group-member) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identities that are not included in peer groups. | List[PeerGroupMember] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.peer_group_member import PeerGroupMember +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + 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, ) + # Below is a request that includes all optional parameters + # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md new file mode 100644 index 000000000..03073d64d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md @@ -0,0 +1,221 @@ +--- +id: beta-iai-recommendations +title: IAI_Recommendations +pagination_label: IAI_Recommendations +sidebar_label: IAI_Recommendations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Recommendations', 'BetaIAI_Recommendations'] +slug: /tools/sdk/python/beta/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAI_Recommendations', 'BetaIAI_Recommendations'] +--- + +# sailpoint.beta.IAIRecommendationsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object +[**get-recommendations-config**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values +[**update-recommendations-config**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values + + +## get-recommendations +Returns a Recommendation Based on Object +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | recommendation_request_dto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True | + +### Return type +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The recommendations for a customer | RecommendationResponseDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.recommendation_request_dto import RecommendationRequestDto +from sailpoint.beta.models.recommendation_response_dto import RecommendationResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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 a Recommendation Based on Object + new_recommendation_request_dto = RecommendationRequestDto() + new_recommendation_request_dto.from_json(recommendation_request_dto) + results =IAIRecommendationsApi(api_client).get_recommendations(new_recommendation_request_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations(new_recommendation_request_dto) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-recommendations-config +Get certification recommendation config values +Retrieves configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Cert recommendation configuration attributes | RecommendationConfigDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get certification recommendation config values + + results =IAIRecommendationsApi(api_client).get_recommendations_config() + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations_config() + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-recommendations-config +Update certification recommendation config values +Updates configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-recommendations-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | recommendation_config_dto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True | + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Cert recommendation configuration attributes after update | RecommendationConfigDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_recommendation_config_dto.from_json(recommendation_config_dto) + results =IAIRecommendationsApi(api_client).update_recommendations_config(new_recommendation_config_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).update_recommendations_config(new_recommendation_config_dto) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md new file mode 100644 index 000000000..0ca2fe9a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md @@ -0,0 +1,1739 @@ +--- +id: beta-iai-role-mining +title: IAI_Role_Mining +pagination_label: IAI_Role_Mining +sidebar_label: IAI_Role_Mining +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Role_Mining', 'BetaIAI_Role_Mining'] +slug: /tools/sdk/python/beta/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAI_Role_Mining', 'BetaIAI_Role_Mining'] +--- + +# sailpoint.beta.IAIRoleMiningApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-potential-role-provision-request**](#create-potential-role-provision-request) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**create-role-mining-sessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session +[**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**get-entitlements-potential-role**](#get-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**get-excluded-entitlements-potential-role**](#get-excluded-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**get-identities-potential-role**](#get-identities-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**get-potential-role**](#get-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieve potential role in session +[**get-potential-role-applications**](#get-potential-role-applications) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**get-potential-role-entitlements**](#get-potential-role-entitlements) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**get-potential-role-source-identity-usage**](#get-potential-role-source-identity-usage) | **GET** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**get-potential-role-summaries**](#get-potential-role-summaries) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieve session's potential role summaries +[**get-role-mining-potential-role**](#get-role-mining-potential-role) | **GET** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-session**](#get-role-mining-session) | **GET** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**get-role-mining-session-status**](#get-role-mining-session-status) | **GET** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**get-role-mining-sessions**](#get-role-mining-sessions) | **GET** `/role-mining-sessions` | Retrieves all role mining sessions +[**get-saved-potential-roles**](#get-saved-potential-roles) | **GET** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**patch-potential-role**](#patch-potential-role) | **PATCH** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role in session +[**patch-role-mining-potential-role**](#patch-role-mining-potential-role) | **PATCH** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**patch-role-mining-session**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**update-entitlements-potential-role**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + + +## create-potential-role-provision-request +Create request to provision a potential role into an actual role. +This method starts a job to provision a potential role + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-potential-role-provision-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + Query | min_entitlement_popularity | **int** | (optional) (default to 0) | Minimum popularity required for an entitlement to be included in the provisioned role. + Query | include_common_access | **bool** | (optional) (default to True) | Boolean determining whether common access entitlements will be included in the provisioned role. + Body | role_mining_potential_role_provision_request | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role + +### Return type +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. Returns a potential role summary including the status of the provison request | RoleMiningPotentialRoleSummary | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest +from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-role-mining-sessions +Create a role mining session +This submits a create role mining session request to the role mining application. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role-mining-sessions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role_mining_session_dto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Submitted a role mining session request | RoleMiningSessionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_session_dto import RoleMiningSessionDto +from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_role_mining_session_dto.from_json(role_mining_session_dto) + results =IAIRoleMiningApi(api_client).create_role_mining_sessions(new_role_mining_session_dto) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).create_role_mining_sessions(new_role_mining_session_dto) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## download-role-mining-potential-role-zip +Export (download) details for a potential role in a role mining session +This endpoint downloads a completed export of information for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-mining-potential-role-zip) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session +Path | export_id | **str** | True | The id of a previously run export job for this potential role + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | 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. | ListAccessModelMetadataAttribute401Response | - | +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/zip, application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + + 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, potential_role_id, export_id) + # 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) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-role-mining-potential-role +Export (download) details for a potential role in a role mining session +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | 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. | ListAccessModelMetadataAttribute401Response | - | +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/zip, application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + + try: + # Export (download) details for a potential role in a role mining session + + results =IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-role-mining-potential-role-async +Asynchronously export details for a potential role in a role mining session and upload to S3 +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + Body | role_mining_potential_role_export_request | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) | + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Job Submitted. Returns a reportId that can be used to download the zip once complete | RoleMiningPotentialRoleExportResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest +from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, new_role_mining_potential_role_export_request) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-role-mining-potential-role-status +Retrieve status of a potential role export job +This endpoint retrieves information about the current status of a potential role export. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session +Path | export_id | **str** | True | The id of a previously run export job for this potential role + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Success. Returns the current status of this export | RoleMiningPotentialRoleExportResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + + try: + # Retrieve status of a potential role export job + + results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + # 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) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-all-potential-role-summaries +Retrieves all potential role summaries +Returns all potential role summaries that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-all-potential-role-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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: **createdDate, identityCount, entitlementCount, freshness, quality** + 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: **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* + 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[RoleMiningPotentialRoleSummary]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns all potential role summaries that match the query parameters. | List[RoleMiningPotentialRoleSummary] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-distribution-potential-role +Retrieves entitlement popularity distribution for a potential role in a role mining session +This method returns entitlement popularity distribution for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-distribution-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + Query | include_common_access | **bool** | (optional) | Boolean determining whether common access entitlements will be included or not + +### Return type +**Dict[str, int]** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a map containing entitlement popularity distribution for a potential role. | Dict[str, int] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) + print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlements-potential-role +Retrieves entitlements for a potential role in a role mining session +This method returns entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlements-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + Query | include_common_access | **bool** | (optional) (default to True) | Boolean determining whether common access entitlements will be included or not + 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: **popularity, entitlementName, applicationName** The default sort is **popularity** 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: **applicationName**: *sw* **entitlementRef.name**: *sw* + 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[RoleMiningEntitlement]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of entitlements for a potential role. | List[RoleMiningEntitlement] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-excluded-entitlements-potential-role +Retrieves excluded entitlements for a potential role in a role mining session +This method returns excluded entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-excluded-entitlements-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + 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: **popularity** + 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: **applicationName**: *sw* **entitlementRef.name**: *sw* + 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[RoleMiningEntitlement]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of excluded entitlements for a potential roles. | List[RoleMiningEntitlement] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identities-potential-role +Retrieves identities for a potential role in a role mining session +This method returns identities for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identities-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + 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* + 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[RoleMiningIdentity]**](../models/role-mining-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of identities for a potential role. | List[RoleMiningIdentity] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_identity import RoleMiningIdentity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role +Retrieve potential role in session +This method returns a specific potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + + try: + # Retrieve potential role in session + + results =IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-applications +Retrieves the applications of a potential role for a role mining session +This method returns the applications of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-applications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + 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: **applicationName**: *sw* + 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[RoleMiningPotentialRoleApplication]**](../models/role-mining-potential-role-application) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential roles for a role mining session. | List[RoleMiningPotentialRoleApplication] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-entitlements +Retrieves the entitlements of a potential role for a role mining session +This method returns the entitlements of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + 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: **entitlementRef.name**: *sw* + 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[RoleMiningPotentialRoleEntitlements]**](../models/role-mining-potential-role-entitlements) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns the entitlements of a potential role for a role mining session. | List[RoleMiningPotentialRoleEntitlements] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, potential_role_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-source-identity-usage +Retrieves potential role source usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-source-identity-usage) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | potential_role_id | **str** | True | A potential role id +Path | source_id | **str** | True | A source id + 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 is supported for the following fields: **displayName, email, usageCount** + 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[RoleMiningPotentialRoleSourceUsage]**](../models/role-mining-potential-role-source-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of source usage for the identities in a potential role. | List[RoleMiningPotentialRoleSourceUsage] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, source_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-summaries +Retrieve session's potential role summaries +This method returns the potential role summaries for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id + 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: **createdDate** + 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: **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* + 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[RoleMiningPotentialRoleSummary]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential role summaries for a role mining session. | List[RoleMiningPotentialRoleSummary] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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: + # Retrieve session's potential role summaries + + results =IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, ) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-potential-role +Retrieves a specific potential role +This method returns a specific potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | potential_role_id | **str** | True | A potential role id + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id + + try: + # Retrieves a specific potential role + + results =IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-session +Get a role mining session +The method retrieves a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id to be retrieved. + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a role mining session | RoleMiningSessionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | 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 | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + + try: + # Get a role mining session + + results =IAIRoleMiningApi(api_client).get_role_mining_session(session_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-session-status +Get role mining session status state +This method returns a role mining session status for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id + +### Return type +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns session status | RoleMiningSessionStatus | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_session_status import RoleMiningSessionStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + + try: + # Get role mining session status state + + results =IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-sessions +Retrieves all role mining sessions +Returns all role mining sessions that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-sessions) + +### 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: **saved**: *eq* **name**: *eq, 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: **createdBy, createdDate** + 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[RoleMiningSessionResponse]**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns all role mining sessions that match the query parameters. | List[RoleMiningSessionResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-saved-potential-roles +Retrieves all saved potential roles +This method returns all saved potential roles (draft roles). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-saved-potential-roles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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 is supported for the following fields: **modified** + 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[RoleMiningSessionDraftRoleDto]**](../models/role-mining-session-draft-role-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of draft roles for a role mining session. | List[RoleMiningSessionDraftRoleDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-potential-role +Update a potential role in session +This method updates an existing potential role using the role mining session id and the potential role summary id. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | The potential role summary id + Body | patch_potential_role_request_inner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + [{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] | + 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 in session + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner() + new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + results =IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, 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, new_patch_potential_role_request_inner) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-role-mining-potential-role +Update a potential role +This method updates an existing potential role. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | potential_role_id | **str** | True | The potential role summary id + Body | patch_potential_role_request_inner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id + [{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] | + 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() + new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + results =IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner) + print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-role-mining-session +Patch a role mining session +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-session) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id to be patched + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-entitlements-potential-role +Edit entitlements for a potential role to exclude some entitlements +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + Body | role_mining_potential_role_edit_entitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Adds or removes entitlements from a potential role's entitlement exclusion list. | RoleMiningPotentialRole | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole +from sailpoint.beta.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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() + new_role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + results =IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, 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, new_role_mining_potential_role_edit_entitlements) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md new file mode 100644 index 000000000..b546bba96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md @@ -0,0 +1,148 @@ +--- +id: beta-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Icons', 'BetaIcons'] +slug: /tools/sdk/python/beta/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'BetaIcons'] +--- + +# sailpoint.beta.IconsApi + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon +[**set-icon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon + + +## delete-icon +Delete an icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-icon) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | object_type | **str** | True | Object type +Path | object_id | **str** | True | Object id. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.icons_api import IconsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + + try: + # Delete an icon + + IconsApi(api_client).delete_icon(object_type, object_id) + # Below is a request that includes all optional parameters + # IconsApi(api_client).delete_icon(object_type, object_id) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-icon +Update an icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-icon) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | object_type | **str** | True | Object type +Path | object_id | **str** | True | Object id. + | image | **bytearray** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + +### Return type +[**SetIcon200Response**](../models/set-icon200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Icon updated | SetIcon200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.icons_api import IconsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.set_icon200_response import SetIcon200Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + 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_id, image) + # Below is a request that includes all optional parameters + # results = IconsApi(api_client).set_icon(object_type, object_id, image) + print("The response of IconsApi->set_icon:\n") + pprint(results) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md new file mode 100644 index 000000000..85dae1839 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md @@ -0,0 +1,747 @@ +--- +id: beta-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identities', 'BetaIdentities'] +slug: /tools/sdk/python/beta/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'BetaIdentities'] +--- + +# sailpoint.beta.IdentitiesApi + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity +[**get-identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details +[**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details +[**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments +[**list-identities**](#list-identities) | **GET** `/identities` | List Identities +[**reset-identity**](#reset-identity) | **POST** `/identities/{identityId}/reset` | Reset an identity +[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email +[**start-identities-invite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register +[**start-identity-processing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds +[**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + + +## delete-identity +Delete identity +The API returns successful response if the requested identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity Id + +### 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 is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. | IdentityAssociationDetails | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + + try: + # Delete identity + + IdentitiesApi(api_client).delete_identity(id) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).delete_identity(id) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity +Identity Details +This API returns a single identity using the Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity Id + +### Return type +[**Identity**](../models/identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity object | Identity | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity import Identity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + + try: + # Identity Details + + results =IdentitiesApi(api_client).get_identity(id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity(id) + print("The response of IdentitiesApi->get_identity:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-ownership-details +Get ownership details +Use this API to return an identity's owned objects that will cause problems for deleting the identity. +Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-ownership-details) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity ID. + +### Return type +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Identity's ownership association details. | IdentityOwnershipAssociationDetails | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. + + try: + # Get ownership details + + results =IdentitiesApi(api_client).get_identity_ownership_details(identity_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assignment +Role assignment details + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity Id +Path | assignment_id | **str** | True | Assignment Id + +### Return type +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A role assignment object | RoleAssignmentDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_assignment_dto import RoleAssignmentDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id + + try: + # Role assignment details + + results =IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assignments +List role assignments +This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignments) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity Id to get the role assignments for + Query | role_id | **str** | (optional) | Role Id to filter the role assignments with + Query | role_name | **str** | (optional) | Role name to filter the role assignments with + +### Return type +[**List[GetRoleAssignments200ResponseInner]**](../models/get-role-assignments200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A role assignment object | List[GetRoleAssignments200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, ) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identities +List Identities +This API returns a list of identities. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identities) + +### 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: **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* + 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, alias, cloudStatus** + Query | default_filter | **str** | (optional) (default to CORRELATED_ONLY) | 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. + 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 | 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[Identity]**](../models/identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identities. | List[Identity] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity import Identity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reset-identity +Reset an identity +Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity Id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. The reset request accepted and is in progress. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + + try: + # Reset an identity + + IdentitiesApi(api_client).reset_identity(identity_id) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).reset_identity(identity_id) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-identity-verification-account-token +Send password reset email +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-identity-verification-account-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity ID + Body | send_account_verification_request | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The email was successfully sent | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.send_account_verification_request import SendAccountVerificationRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_send_account_verification_request.from_json(send_account_verification_request) + IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-identities-invite +Invite identities to register +This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identities-invite) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | invite_identities_request | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True | + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Responds with an initial TaskStatus for the executed task | TaskStatus | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.invite_identities_request import InviteIdentitiesRequest +from sailpoint.beta.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + invite_identities_request = { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } # InviteIdentitiesRequest | + + try: + # Invite identities to register + new_invite_identities_request = InviteIdentitiesRequest() + new_invite_identities_request.from_json(invite_identities_request) + results =IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-identity-processing +Process a list of identityIds +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 endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identity-processing) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | process_identities_request | [**ProcessIdentitiesRequest**](../models/process-identities-request) | True | + +### Return type +[**TaskResultResponse**](../models/task-result-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Object containing the DTO type TASK_RESULT and the job id for the task | TaskResultResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.process_identities_request import ProcessIdentitiesRequest +from sailpoint.beta.models.task_result_response import TaskResultResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + process_identities_request = { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } # ProcessIdentitiesRequest | + + try: + # Process a list of identityIds + new_process_identities_request = ProcessIdentitiesRequest() + new_process_identities_request.from_json(process_identities_request) + results =IdentitiesApi(api_client).start_identity_processing(new_process_identities_request) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).start_identity_processing(new_process_identities_request) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) +``` + + + +[[Back to top]](#) + +## synchronize-attributes-for-identity +Attribute synchronization for single identity. +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/synchronize-attributes-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | The Identity id + +### Return type +[**IdentitySyncJob**](../models/identity-sync-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | An Identity Sync job | IdentitySyncJob | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_sync_job import IdentitySyncJob +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id + + try: + # Attribute synchronization for single identity. + + results =IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md new file mode 100644 index 000000000..637affcfb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md @@ -0,0 +1,436 @@ +--- +id: beta-identity-attributes +title: Identity_Attributes +pagination_label: Identity_Attributes +sidebar_label: Identity_Attributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_Attributes', 'BetaIdentity_Attributes'] +slug: /tools/sdk/python/beta/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'Identity_Attributes', 'BetaIdentity_Attributes'] +--- + +# sailpoint.beta.IdentityAttributesApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-attribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**get-identity-attribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute +[**list-identity-attributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes +[**put-identity-attribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute + + +## create-identity-attribute +Create Identity Attribute +Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_attribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The identity attribute was created successfully. | IdentityAttribute | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_identity_attribute.from_json(identity_attribute) + results =IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-attribute +Delete Identity Attribute +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The attribute's technical name. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + + try: + # Delete Identity Attribute + + IdentityAttributesApi(api_client).delete_identity_attribute(name) + # Below is a request that includes all optional parameters + # IdentityAttributesApi(api_client).delete_identity_attribute(name) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-attributes-in-bulk +Bulk delete Identity Attributes +Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_attribute_names | [**IdentityAttributeNames**](../models/identity-attribute-names) | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_attribute_names import IdentityAttributeNames +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_attribute_names = { + "ids" : [ "name", "displayName" ] + } # IdentityAttributeNames | + + try: + # Bulk delete Identity Attributes + new_identity_attribute_names = IdentityAttributeNames() + new_identity_attribute_names.from_json(identity_attribute_names) + IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names) + # Below is a request that includes all optional parameters + # IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-attribute +Get Identity Attribute +This gets an identity attribute for a given technical name. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The attribute's technical name. + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity attribute with the given name | IdentityAttribute | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + + try: + # Get Identity Attribute + + results =IdentityAttributesApi(api_client).get_identity_attribute(name) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).get_identity_attribute(name) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-attributes +List Identity Attributes +Use this API to get a collection of identity attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | include_system | **bool** | (optional) (default to False) | Include 'system' attributes in the response. + Query | include_silent | **bool** | (optional) (default to False) | Include 'silent' attributes in the response. + Query | searchable_only | **bool** | (optional) (default to False) | Include only 'searchable' attributes in the response. + 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[IdentityAttribute]**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity attributes. | List[IdentityAttribute] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-identity-attribute +Update Identity Attribute +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The attribute's technical name. + Body | identity_attribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity attribute was updated successfully | IdentityAttribute | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + 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() + new_identity_attribute.from_json(identity_attribute) + results =IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md new file mode 100644 index 000000000..6d32a5cc5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md @@ -0,0 +1,777 @@ +--- +id: beta-identity-history +title: Identity_History +pagination_label: Identity_History +sidebar_label: Identity_History +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_History', 'BetaIdentity_History'] +slug: /tools/sdk/python/beta/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'Identity_History', 'BetaIdentity_History'] +--- + +# sailpoint.beta.IdentityHistoryApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**compare-identity-snapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**get-historical-identity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity +[**get-historical-identity-events**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity +[**get-identity-snapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**get-identity-start-date**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**list-historical-identities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities +[**list-identity-access-items**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot +[**list-identity-snapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + + +## compare-identity-snapshots +Gets a difference of count for each access item types for the given identity between 2 snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + Query | snapshot1 | **str** | (optional) | The snapshot 1 of identity + Query | snapshot2 | **str** | (optional) | The snapshot 2 of identity + Query | access_item_types | **[]str** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + 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[IdentityCompareResponse]**](../models/identity-compare-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A IdentityCompare object with difference details for each access item type | List[IdentityCompareResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_compare_response import IdentityCompareResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + +## compare-identity-snapshots-access-type +Gets a list of differences of specific accessType for the given identity between 2 snapshots +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots-access-type) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id +Path | access_type | **str** | True | The specific type which needs to be compared + Query | access_associated | **bool** | (optional) | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + Query | snapshot1 | **str** | (optional) | The snapshot 1 of identity + Query | snapshot2 | **str** | (optional) | The snapshot 2 of identity + 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[AccessItemDiff]**](../models/access-item-diff) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of events for the identity | List[AccessItemDiff] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.access_item_diff import AccessItemDiff +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, access_type, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-historical-identity +Get latest snapshot of identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity object. | IdentityHistoryResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + + try: + # Get latest snapshot of identity + + results =IdentityHistoryApi(api_client).get_historical_identity(id) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_historical_identity(id) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-historical-identity-events +Lists all events for the given identity +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity-events) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + Query | var_from | **str** | (optional) | The optional instant until which access events are returned + Query | event_types | **[]str** | (optional) | An optional list of event types to return. If null or empty, all events are returned + Query | access_item_types | **[]str** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + 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[GetHistoricalIdentityEvents200ResponseInner]**](../models/get-historical-identity-events200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of events for the identity | List[GetHistoricalIdentityEvents200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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) + + 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, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->get_historical_identity_events:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-snapshot +Gets an identity snapshot at a given date +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-snapshot) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id +Path | var_date | **str** | True | The specified date + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity object. | IdentityHistoryResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + + try: + # Gets an identity snapshot at a given date + + results =IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-snapshot-summary +Gets the summary for the event count for a specific identity +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-snapshot-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + Query | before | **str** | (optional) | The date before which snapshot summary is required + Query | interval | **str** | (optional) | The interval indicating day or month. Defaults to month if not specified + Query | time_zone | **str** | (optional) | The time zone. Defaults to UTC if not provided + 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[MetricResponse]**](../models/metric-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A summary list of identity changes in date histogram format. | List[MetricResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.metric_response import MetricResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) + print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-start-date +Gets the start date of the identity +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-start-date) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The start date of the identity | 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. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + + try: + # Gets the start date of the identity + + results =IdentityHistoryApi(api_client).get_identity_start_date(id) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_start_date(id) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-historical-identities +Lists all the identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-historical-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | starts_with_query | **str** | (optional) | This param is used for starts-with search for first, last and display name of the identity + Query | is_deleted | **bool** | (optional) | Indicates if we want to only list down deleted identities or not. + Query | is_active | **bool** | (optional) | Indicates if we want to only list active or inactive identities. + 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[IdentityListItem]**](../models/identity-list-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identities for the customer. | List[IdentityListItem] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_list_item import IdentityListItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) + print("The response of IdentityHistoryApi->list_historical_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-access-items +List Access Items by Identity +This method retrieves a list of access item for the identity filtered by the access item type + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-access-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + Query | type | **str** | (optional) | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** + 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** + Query | query | **str** | (optional) | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, 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 | 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 | 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[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of access items. | List[ListIdentityAccessItems200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + filters = 'source eq \"DataScienceDataset\"' # 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + query = 'Dr. Arden' # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-snapshot-access-items +Get Identity Access Items Snapshot +Use this API to get a list of identity access items at a specified date, filtered by item type. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshot-access-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity ID. +Path | var_date | **str** | True | Specified date. + Query | type | **str** | (optional) | Access item type. + +### Return type +[**List[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Identity object. | List[ListIdentityAccessItems200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID. + var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date. + type = 'account' # str | Access item type. (optional) # str | Access item type. (optional) + + try: + # Get Identity Access Items Snapshot + + results =IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-snapshots +Lists all the snapshots for the identity +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshots) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + Query | start | **str** | (optional) | The specified start date + Query | interval | **str** | (optional) | The interval indicating the range in day or month for the specified interval-name + 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[IdentitySnapshotSummaryResponse]**](../models/identity-snapshot-summary-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of identity summary for each snapshot. | List[IdentitySnapshotSummaryResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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, ) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md new file mode 100644 index 000000000..c8024bea3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md @@ -0,0 +1,890 @@ +--- +id: beta-identity-profiles +title: Identity_Profiles +pagination_label: Identity_Profiles +sidebar_label: Identity_Profiles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_Profiles', 'BetaIdentity_Profiles'] +slug: /tools/sdk/python/beta/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'Identity_Profiles', 'BetaIdentity_Profiles'] +--- + +# sailpoint.beta.IdentityProfilesApi + Use this API to implement and customize identity profile functionality. +With this functionality in place, administrators can manage identity profiles and configure them for use by identities throughout Identity Security Cloud. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. +This allows administrators to save time by applying identity profiles to any number of similar identities rather than configuring each one individually. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. They can select an identity profile to view and modify its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. +Administrators can also use this page to create new identity profiles or delete existing ones. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config +[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**show-generate-identity-preview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**sync-identity-profile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Create an identity profile. +A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_profile | [**IdentityProfile**](../models/identity-profile) | True | + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created identity profile | IdentityProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_profile import IdentityProfile +from pprint import pprint +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" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "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" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } # IdentityProfile | + + try: + # Create Identity Profile + new_identity_profile = IdentityProfile() + new_identity_profile.from_json(identity_profile) + results =IdentityProfilesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_result_simplified import TaskResultSimplified +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +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. + +A token with ORG_ADMIN authority is required to call this API. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | True | Identity Profile bulk delete request body. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_result_simplified import TaskResultSimplified +from pprint import pprint +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. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + + try: + # Delete Identity Profiles + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =IdentityProfilesApi(api_client).delete_identity_profiles(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-identity-profiles) + +### 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, ne* **name**: *eq, ne* **priority**: *eq, ne* + 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, priority** + +### Return type +[**List[IdentityProfileExportedObject]**](../models/identity-profile-exported-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of export objects with identity profiles. | List[IdentityProfileExportedObject] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject +from pprint import pprint +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 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-default-identity-attribute-config +Default identity attribute config +This returns the default identity attribute config +A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-identity-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | The Identity Profile ID + +### Return type +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An Identity Attribute Config object | IdentityAttributeConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_attribute_config import IdentityAttributeConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID + + try: + # Default identity attribute config + + results =IdentityProfilesApi(api_client).get_default_identity_attribute_config(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Identity profile object. | IdentityProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_profile import IdentityProfile +from pprint import pprint +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: + # Get Identity Profile + + results =IdentityProfilesApi(api_client).get_identity_profile(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-identity-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_profile_exported_object | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. + +### Return type +[**ObjectImportResult**](../models/object-import-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of importing Identity Profiles. | ObjectImportResult | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject +from sailpoint.beta.models.object_import_result import ObjectImportResult +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject() + new_identity_profile_exported_object.from_json(identity_profile_exported_object) + results =IdentityProfilesApi(api_client).import_identity_profiles(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. +A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles) + +### 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + 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, priority, created, modified, owner.id, owner.name** + +### Return type +[**List[IdentityProfile]**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity profiles. | List[IdentityProfile] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_profile import IdentityProfile +from pprint import pprint +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 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## show-generate-identity-preview +Generate Identity Profile Preview +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. +A token with ORG_ADMIN authority is required to call this API to generate an identity preview. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/show-generate-identity-preview) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. + +### Return type +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_preview_request import IdentityPreviewRequest +from sailpoint.beta.models.identity_preview_response import IdentityPreviewResponse +from pprint import pprint +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() + new_identity_preview_request.from_json(identity_preview_request) + results =IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request) + print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +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. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | The Identity Profile ID to be processed + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +Update the specified identity profile with this PATCH request. +A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. +These fields cannot be updated: +* id +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at once. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated identity profile. | IdentityProfile | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_profile import IdentityProfile +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/Index.md b/docs/tools/sdk/python/Reference/Beta/Methods/Index.md new file mode 100644 index 000000000..ff8c231b3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['python', 'Python', 'sdk', 'methods'] +slug: /tools/sdk/python/beta/methods +tags: ['SDK', 'Software Development Kit', 'beta', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **Beta** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md new file mode 100644 index 000000000..0052c2eef --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md @@ -0,0 +1,417 @@ +--- +id: beta-launchers +title: Launchers +pagination_label: Launchers +sidebar_label: Launchers +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Launchers', 'BetaLaunchers'] +slug: /tools/sdk/python/beta/methods/launchers +tags: ['SDK', 'Software Development Kit', 'Launchers', 'BetaLaunchers'] +--- + +# sailpoint.beta.LaunchersApi + Use this API to manage Launchers. + +Launchers are objects that allow users to launch various tasks from ISC such as Privileged Workflows. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-launcher**](#create-launcher) | **POST** `/launchers` | Create launcher +[**delete-launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete Launcher +[**get-launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get Launcher by ID +[**get-launchers**](#get-launchers) | **GET** `/launchers` | List all Launchers for tenant +[**put-launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher +[**start-launcher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher + + +## create-launcher +Create launcher +Create a Launcher with given information + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-launcher) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher + +### Return type +[**Launcher**](../models/launcher) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Launcher created successfully | Launcher | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.launcher import Launcher +from sailpoint.beta.models.launcher_request import LauncherRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to create a Launcher + + try: + # Create launcher + new_launcher_request = LauncherRequest() + new_launcher_request.from_json(launcher_request) + results =LaunchersApi(api_client).create_launcher(new_launcher_request) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).create_launcher(new_launcher_request) + print("The response of LaunchersApi->create_launcher:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-launcher +Delete Launcher +Delete the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | launcher_id | **str** | True | ID of the Launcher to be deleted + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Launcher deleted successfully | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted + + try: + # Delete Launcher + + LaunchersApi(api_client).delete_launcher(launcher_id) + # Below is a request that includes all optional parameters + # LaunchersApi(api_client).delete_launcher(launcher_id) + except Exception as e: + print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-launcher +Get Launcher by ID +Get details for the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | launcher_id | **str** | True | ID of the Launcher to be retrieved + +### Return type +[**Launcher**](../models/launcher) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Launcher retrieved successfully | Launcher | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.launcher import Launcher +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved + + try: + # Get Launcher by ID + + results =LaunchersApi(api_client).get_launcher(launcher_id) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).get_launcher(launcher_id) + print("The response of LaunchersApi->get_launcher:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-launchers +List all Launchers for tenant +Return a list of Launchers for the authenticated tenant + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers) + +### 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: **description**: *sw* **disabled**: *eq* **name**: *sw* + Query | next | **str** | (optional) | Pagination marker + Query | limit | **int** | (optional) (default to 10) | Number of Launchers to return + +### Return type +[**GetLaunchers200Response**](../models/get-launchers200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Launchers | GetLaunchers200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_launchers200_response import GetLaunchers200Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + filters = 'disabled 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: **description**: *sw* **disabled**: *eq* **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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional) + limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10) + + try: + # List all Launchers for tenant + + results =LaunchersApi(api_client).get_launchers() + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).get_launchers(filters, next, limit) + print("The response of LaunchersApi->get_launchers:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-launcher +Replace Launcher +Replace the given Launcher ID with given payload + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | launcher_id | **str** | True | ID of the Launcher to be replaced + Body | launcher_request | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher + +### Return type +[**Launcher**](../models/launcher) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Launcher replaced successfully | Launcher | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.launcher import Launcher +from sailpoint.beta.models.launcher_request import LauncherRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to replace Launcher + + try: + # Replace Launcher + new_launcher_request = LauncherRequest() + new_launcher_request.from_json(launcher_request) + results =LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request) + print("The response of LaunchersApi->put_launcher:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-launcher +Launch a Launcher +Launch the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | launcher_id | **str** | True | ID of the Launcher to be launched + +### Return type +[**StartLauncher200Response**](../models/start-launcher200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Launcher launched successfully | StartLauncher200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.start_launcher200_response import StartLauncher200Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched + + try: + # Launch a Launcher + + results =LaunchersApi(api_client).start_launcher(launcher_id) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).start_launcher(launcher_id) + print("The response of LaunchersApi->start_launcher:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md new file mode 100644 index 000000000..621491205 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md @@ -0,0 +1,197 @@ +--- +id: beta-lifecycle-states +title: Lifecycle_States +pagination_label: Lifecycle_States +sidebar_label: Lifecycle_States +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Lifecycle_States', 'BetaLifecycle_States'] +slug: /tools/sdk/python/beta/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'Lifecycle_States', 'BetaLifecycle_States'] +--- + +# sailpoint.beta.LifecycleStatesApi + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can view and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to select the lifecycle state they want to modify. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## get-lifecycle-states +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-lifecycle-states) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity Profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle State ID. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Requested lifecycle state. | LifecycleState | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.lifecycle_state import LifecycleState +from pprint import pprint +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_states(identity_profile_id, lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-lifecycle-states) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity Profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle State ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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 + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated lifecycle state. | LifecycleState | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.lifecycle_state import LifecycleState +from pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md new file mode 100644 index 000000000..e05cc91eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md @@ -0,0 +1,518 @@ +--- +id: beta-mfa-configuration +title: MFA_Configuration +pagination_label: MFA_Configuration +sidebar_label: MFA_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MFA_Configuration', 'BetaMFA_Configuration'] +slug: /tools/sdk/python/beta/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFA_Configuration', 'BetaMFA_Configuration'] +--- + +# sailpoint.beta.MFAConfigurationApi + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + + +## delete-mfa-config +Delete MFA method configuration +This API removes the configuration for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an MFA method. | MfaOktaConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-duo-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration of an Duo MFA method. | MfaDuoConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-kba-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | all_languages | **bool** | (optional) | 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 + +### Return type +[**List[KbaQuestion]**](../models/kba-question) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration for KBA MFA method. | List[KbaQuestion] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.kba_question import KbaQuestion +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-okta-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration of an Okta MFA method. | MfaOktaConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-duo-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | mfa_duo_config | [**MfaDuoConfig**](../models/mfa-duo-config) | True | + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an Duo MFA method. | MfaDuoConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig +from pprint import pprint +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() + new_mfa_duo_config.from_json(mfa_duo_config) + results =MFAConfigurationApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-okta-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | mfa_okta_config | [**MfaOktaConfig**](../models/mfa-okta-config) | True | + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an Okta MFA method. | MfaOktaConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig +from pprint import pprint +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() + new_mfa_okta_config.from_json(mfa_okta_config) + results =MFAConfigurationApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfakba-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | kba_answer_request_item | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**List[KbaAnswerResponseItem]**](../models/kba-answer-response-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The new KBA configuration for the user. | List[KbaAnswerResponseItem] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem +from sailpoint.beta.models.kba_answer_response_item import KbaAnswerResponseItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAConfigurationApi(api_client).set_mfakba_config(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-mfa-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mfa_config_test_response import MfaConfigTestResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md new file mode 100644 index 000000000..14ae77db6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md @@ -0,0 +1,414 @@ +--- +id: beta-mfa-controller +title: MFA_Controller +pagination_label: MFA_Controller +sidebar_label: MFA_Controller +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MFA_Controller', 'BetaMFA_Controller'] +slug: /tools/sdk/python/beta/methods/mfa-controller +tags: ['SDK', 'Software Development Kit', 'MFA_Controller', 'BetaMFA_Controller'] +--- + +# sailpoint.beta.MFAControllerApi + This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-send-token**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token +[**ping-verification-status**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest +[**send-duo-verify-request**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method +[**send-kba-answers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method +[**send-okta-verify-request**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method +[**send-token-auth-request**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method + + +## create-send-token +Create and send user token +This API send token request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-send-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | send_token_request | [**SendTokenRequest**](../models/send-token-request) | True | + +### Return type +[**SendTokenResponse**](../models/send-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Token send status. | SendTokenResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.send_token_request import SendTokenRequest +from sailpoint.beta.models.send_token_response import SendTokenResponse +from pprint import pprint +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() + new_send_token_request.from_json(send_token_request) + results =MFAControllerApi(api_client).create_send_token(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## ping-verification-status +Polling MFA method by VerificationPollRequest +This API poll the VerificationPollRequest for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-verification-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + Body | verification_poll_request | [**VerificationPollRequest**](../models/verification-poll-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA VerificationPollRequest status an MFA method. | VerificationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.verification_poll_request import VerificationPollRequest +from sailpoint.beta.models.verification_response import VerificationResponse +from pprint import pprint +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() + new_verification_poll_request.from_json(verification_poll_request) + results =MFAControllerApi(api_client).ping_verification_status(method, 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-duo-verify-request +Verifying authentication via Duo method +This API Authenticates the user via Duo-Web MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-duo-verify-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | duo_verification_request | [**DuoVerificationRequest**](../models/duo-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The status of verification request. | VerificationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.duo_verification_request import DuoVerificationRequest +from sailpoint.beta.models.verification_response import VerificationResponse +from pprint import pprint +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() + new_duo_verification_request.from_json(duo_verification_request) + results =MFAControllerApi(api_client).send_duo_verify_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-kba-answers +Authenticate KBA provided MFA method +This API Authenticate user in KBA MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-kba-answers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | kba_answer_request_item | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAuthResponse**](../models/kba-auth-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | KBA authenticated status. | KbaAuthResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem +from sailpoint.beta.models.kba_auth_response import KbaAuthResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + + try: + # Authenticate KBA provided MFA method + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAControllerApi(api_client).send_kba_answers(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-okta-verify-request +Verifying authentication via Okta method +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-okta-verify-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | okta_verification_request | [**OktaVerificationRequest**](../models/okta-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The status of verification request. | VerificationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.okta_verification_request import OktaVerificationRequest +from sailpoint.beta.models.verification_response import VerificationResponse +from pprint import pprint +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() + new_okta_verification_request.from_json(okta_verification_request) + results =MFAControllerApi(api_client).send_okta_verify_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-token-auth-request +Authenticate Token provided MFA method +This API Authenticate user in Token MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-token-auth-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | token_auth_request | [**TokenAuthRequest**](../models/token-auth-request) | True | + +### Return type +[**TokenAuthResponse**](../models/token-auth-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Token authenticated status. | TokenAuthResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.token_auth_request import TokenAuthRequest +from sailpoint.beta.models.token_auth_response import TokenAuthResponse +from pprint import pprint +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() + new_token_auth_request.from_json(token_auth_request) + results =MFAControllerApi(api_client).send_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md new file mode 100644 index 000000000..4ddf202b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md @@ -0,0 +1,183 @@ +--- +id: beta-managed-clients +title: Managed_Clients +pagination_label: Managed_Clients +sidebar_label: Managed_Clients +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Managed_Clients', 'BetaManaged_Clients'] +slug: /tools/sdk/python/beta/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'Managed_Clients', 'BetaManaged_Clients'] +--- + +# sailpoint.beta.ManagedClientsApi + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status. +[**update-managed-client-status**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client + + +## get-managed-client-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Specified Managed Client Status. +Retrieve Managed Client Status by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-client-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Managed Client Status to get + Query | type | [**ManagedClientType**](../models/managed-client-type) | True | Type of the Managed Client Status to get + +### Return type +[**ManagedClientStatus**](../models/managed-client-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with Managed Client Status having the given ID and Type. | ManagedClientStatus | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.managed_clients_api import ManagedClientsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.managed_client_status import ManagedClientStatus +from sailpoint.beta.models.managed_client_type import ManagedClientType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + + try: + # Specified Managed Client Status. + + results =ManagedClientsApi(api_client).get_managed_client_status(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-managed-client-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Handle status request from client +Update a status detail passed in from the client + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-managed-client-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Managed Client Status to update + Body | managed_client_status | [**ManagedClientStatus**](../models/managed-client-status) | True | + +### Return type +[**ManagedClientStatusAggResponse**](../models/managed-client-status-agg-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the updated Managed Client Status. | ManagedClientStatusAggResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.managed_clients_api import ManagedClientsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.managed_client_status import ManagedClientStatus +from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = { + "body" : { + "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" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } # ManagedClientStatus | + + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus() + new_managed_client_status.from_json(managed_client_status) + results =ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md new file mode 100644 index 000000000..1654106f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md @@ -0,0 +1,292 @@ +--- +id: beta-managed-clusters +title: Managed_Clusters +pagination_label: Managed_Clusters +sidebar_label: Managed_Clusters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Managed_Clusters', 'BetaManaged_Clusters'] +slug: /tools/sdk/python/beta/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'Managed_Clusters', 'BetaManaged_Clusters'] +--- + +# sailpoint.beta.ManagedClustersApi + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-client-log-configuration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration +[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified ManagedCluster. +[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters. +[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration + + +## get-client-log-configuration +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get managed cluster's log configuration +Get managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-client-log-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of ManagedCluster to get log configuration for + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Log configuration of ManagedCluster matching given cluster ID | ClientLogConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + + try: + # Get managed cluster's log configuration + + results =ManagedClustersApi(api_client).get_client_log_configuration(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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-cluster +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get a specified ManagedCluster. +Retrieve a ManagedCluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the ManagedCluster to get + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with ManagedCluster having the given ID. | ManagedCluster | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.managed_cluster import ManagedCluster +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + + try: + # Get a specified ManagedCluster. + + results =ManagedClustersApi(api_client).get_managed_cluster(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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-clusters +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Retrieve all Managed Clusters. +Retrieve all Managed Clusters for the current Org, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters) + +### 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: **operational**: *eq* + +### Return type +[**List[ManagedCluster]**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a list of ManagedCluster. | List[ManagedCluster] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.managed_cluster import ManagedCluster +from pprint import pprint +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: + # Retrieve all 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-client-log-configuration +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update managed cluster's log configuration +Update managed cluster's log configuration + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of ManagedCluster to update log configuration for + Body | client_log_configuration | [**ClientLogConfiguration**](../models/client-log-configuration) | True | ClientLogConfiguration for given ManagedCluster + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with updated ClientLogConfiguration for given ManagedCluster | ClientLogConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + + try: + # Update managed cluster's log configuration + + results =ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md new file mode 100644 index 000000000..2064bbf1c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md @@ -0,0 +1,899 @@ +--- +id: beta-multi-host-integration +title: Multi_Host_Integration +pagination_label: Multi_Host_Integration +sidebar_label: Multi_Host_Integration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Multi_Host_Integration', 'BetaMulti_Host_Integration'] +slug: /tools/sdk/python/beta/methods/multi-host-integration +tags: ['SDK', 'Software Development Kit', 'Multi_Host_Integration', 'BetaMulti_Host_Integration'] +--- + +# sailpoint.beta.MultiHostIntegrationApi + Use this API to build a Multi-Host Integration. +Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. +In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-multi-host-integration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration +[**delete-multi-host**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID +[**get-multi-host-integrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source +[**update-multi-host-sources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration + + +## create-multi-host-integration +Create Multi-Host Integration +This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-multi-host-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | multi_host_integrations_create | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | True | The specifics of the Multi-Host Integration to create + +### Return type +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations +from sailpoint.beta.models.multi_host_integrations_create import MultiHostIntegrationsCreate +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multi_host_integrations_create = { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + try: + # Create Multi-Host Integration + new_multi_host_integrations_create = MultiHostIntegrationsCreate() + new_multi_host_integrations_create.from_json(multi_host_integrations_create) + results =MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) + print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-sources-within-multi-host +Create Sources Within Multi-Host Integration +This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sources-within-multi-host) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration. + Body | multi_host_integrations_create_sources | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | True | The specifics of the sources to create within Multi-Host Integration. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + [sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + multi_host_integrations_create_sources = { + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + } # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + + + try: + # Create Sources Within Multi-Host Integration + new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources() + new_multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) + MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources) + # Below is a request that includes all optional parameters + # MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-multi-host +Delete Multi-Host Integration +Delete an existing Multi-Host Integration by ID. + +A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-multi-host) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of Multi-Host Integration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. + + try: + # Delete Multi-Host Integration + + MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) + # Below is a request that includes all optional parameters + # MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-acct-aggregation-groups +Get Account Aggregation Groups Within Multi-Host Integration ID +This API will return array of account aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-acct-aggregation-groups) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration to update + +### Return type +[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationsAggScheduleUpdate | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + + try: + # Get Account Aggregation Groups Within Multi-Host Integration ID + + results =MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id) + print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-aggregation-groups +Get Entitlement Aggregation Groups Within Multi-Host Integration ID +This API will return array of aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-aggregation-groups) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multi_host_id | **str** | True | ID of the Multi-Host Integration to update + +### Return type +[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationsAggScheduleUpdate | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + + try: + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + results =MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id) + print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-multi-host-integrations +Get Multi-Host Integration By ID +Get an existing Multi-Host Integration. + +A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration. + +### Return type +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + + try: + # Get Multi-Host Integration By ID + + results =MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-multi-host-integrations-list +List All Existing Multi-Host Integrations +Get a list of Multi-Host Integrations. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations-list) + +### 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 | 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: **type**: *in* **forSubAdminId**: *in* + 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 | for_subadmin | **str** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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. + +### Return type +[**List[MultiHostIntegrations]**](../models/multi-host-integrations) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | List[MultiHostIntegrations] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations +from pprint import pprint +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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *in* **forSubAdminId**: *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: **type**: *in* **forSubAdminId**: *in* (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) + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) + + try: + # List All Existing Multi-Host Integrations + + results =MultiHostIntegrationApi(api_client).get_multi_host_integrations_list() + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-multi-host-source-creation-errors +List Multi-Host Source Creation Errors +Get a list of sources creation errors within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-source-creation-errors) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multi_host_id | **str** | True | ID of the Multi-Host Integration + +### Return type +[**List[SourceCreationErrors]**](../models/source-creation-errors) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | List[SourceCreationErrors] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_creation_errors import SourceCreationErrors +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + + try: + # List Multi-Host Source Creation Errors + + results =MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) + print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-multihost-integration-types +List Multi-Host Integration Types +This API endpoint returns the current list of supported Multi-Host Integration types. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multihost-integration-types) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[MultiHostIntegrationTemplateType]**](../models/multi-host-integration-template-type) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | List[MultiHostIntegrationTemplateType] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Multi-Host Integration Types + + results =MultiHostIntegrationApi(api_client).get_multihost_integration_types() + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() + print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sources-within-multi-host +List Sources Within Multi-Host Integration +Get a list of sources within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sources-within-multi-host) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration to update + 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 | 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: **id**: *in* + 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[MultiHostSources]**](../models/multi-host-sources) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | List[MultiHostSources] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_host_sources import MultiHostSources +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *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**: *in* (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) + + try: + # List Sources Within Multi-Host Integration + + results =MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, ) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) + print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-connection-multi-host-sources +Test Configuration For Multi-Host Integration +This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-connection-multi-host-sources) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + + try: + # Test Configuration For Multi-Host Integration + + MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id) + # Below is a request that includes all optional parameters + # MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-source-connection-multihost +Test Configuration For Multi-Host Integration's Single Source +This endpoint performs a more detailed validation of the source's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection-multihost) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration +Path | source_id | **str** | True | ID of the source within the Multi-Host Integration + +### Return type +[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | TestSourceConnectionMultihost200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration + + try: + # Test Configuration For Multi-Host Integration's Single Source + + results =MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) + print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-multi-host-sources +Update Multi-Host Integration +Update existing sources within Multi-Host Integration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-multi-host-sources) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | multihost_id | **str** | True | ID of the Multi-Host Integration to update. + Body | update_multi_host_sources_request_inner | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | True | This endpoint allows you to update a Multi-Host Integration. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK. Returned if the request was successfully accepted into the system. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. + [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + + + try: + # Update Multi-Host Integration + new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner() + new_update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) + MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner) + # Below is a request that includes all optional parameters + # MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md new file mode 100644 index 000000000..744d59bce --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md @@ -0,0 +1,2147 @@ +--- +id: beta-non-employee-lifecycle-management +title: Non_Employee_Lifecycle_Management +pagination_label: Non_Employee_Lifecycle_Management +sidebar_label: Non_Employee_Lifecycle_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Non_Employee_Lifecycle_Management', 'BetaNon_Employee_Lifecycle_Management'] +slug: /tools/sdk/python/beta/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'Non_Employee_Lifecycle_Management', 'BetaNon_Employee_Lifecycle_Management'] +--- + +# sailpoint.beta.NonEmployeeLifecycleManagementApi + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute +[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-record-in-bulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute +[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes +[**export-non-employee-records**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**get-non-employee-approval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Bulk upload status on source +[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute +[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Body | non_employee_approval_decision | [**NonEmployeeApprovalDecision**](../models/non-employee-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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_approval_decision import NonEmployeeApprovalDecision +from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_approval_decision = { + "comment" : "comment" + } # NonEmployeeApprovalDecision | + + try: + # Approve a Non-Employee Request + new_non_employee_approval_decision = NonEmployeeApprovalDecision() + new_non_employee_approval_decision.from_json(non_employee_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Request will require the following security scope: +'idn:nesr:create' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_record import NonEmployeeRecord +from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody +from pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +This request will create a non-employee request and notify the approver + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request creation object | NonEmployeeRequest | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_request import NonEmployeeRequest +from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody +from pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_source_request_body | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. + +### Return type +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_source_request_body import NonEmployeeSourceRequestBody +from sailpoint.beta.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId +from pprint import pprint +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() + new_non_employee_source_request_body.from_json(non_employee_source_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create Non-Employee Source Schema Attribute +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | non_employee_schema_attribute_body | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Schema Attribute created. | NonEmployeeSchemaAttribute | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from sailpoint.beta.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c91808b6ef1d43e016efba0ce470904' # 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 Non-Employee Source Schema Attribute + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody() + new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee record id (UUID) + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808b6ef1d43e016efba0ce470904' # 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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-record-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. +Request will require the following scope: +'idn:nesr:delete' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | delete_non_employee_record_in_bulk_request | [**DeleteNonEmployeeRecordInBulkRequest**](../models/delete-non-employee-record-in-bulk-request) | True | Non-Employee bulk delete request body. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.delete_non_employee_record_in_bulk_request import DeleteNonEmployeeRecordInBulkRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + + try: + # Delete Multiple Non-Employee Records + new_delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest() + new_delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(new_delete_non_employee_record_in_bulk_request) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(new_delete_non_employee_record_in_bulk_request) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee request id in the UUID format + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808b6ef1d43e016efba0ce470904' # 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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete Non-Employee Source's Schema Attribute +This end-point deletes a specific schema attribute for a non-employee source. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + + try: + # Delete Non-Employee Source's Schema Attribute + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + + try: + # Delete Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes +This end-point deletes all custom schema attributes for a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + + try: + # Delete all custom schema attributes + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(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) +``` + + + +[[Back to top]](#) + +## export-non-employee-records +Exports Non-Employee Records to CSV +This requests a CSV download for all non-employees from a provided source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-records) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported CSV | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + + try: + # Exports Non-Employee Records to CSV + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(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) +``` + + + +[[Back to top]](#) + +## export-non-employee-source-schema-template +Exports Source Schema Template +This requests a download for the Source Schema Template for a provided source. +Request will require the following security scope: +idn:nesr:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-source-schema-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported Source Schema Template | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + + try: + # Exports Source Schema Template + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(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) +``` + + + +[[Back to top]](#) + +## get-non-employee-approval +Get a non-employee approval item detail +Approves a non-employee approval request and notifies the next approver. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Query | include_detail | **str** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + +### Return type +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | 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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, 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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | requested_for | **str** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + +### Return type +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | summary of non-employee approval requests | NonEmployeeApprovalSummary | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_approval_summary import NonEmployeeApprovalSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Bulk upload status on source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-bulk-upload-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID (UUID) + +### Return type +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID) + + try: + # Bulk upload status on source + + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee record id (UUID) + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee record object | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_record import NonEmployeeRecord +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808b6ef1d43e016efba0ce470904' # 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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +This gets a non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee request id (UUID) + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request object. | NonEmployeeRequest | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_request import NonEmployeeRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808b6ef1d43e016efba0ce470904' # 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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, 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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | requested_for | **str** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + +### Return type +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request summary object. | NonEmployeeRequestSummary | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_request_summary import NonEmployeeRequestSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +This API gets a schema attribute by Id for the specified Non-Employee SourceId. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema Attribute | NonEmployeeSchemaAttribute | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c918085842e69ae018432d22ccb212f' # 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, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +This gets a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_source import NonEmployeeSource +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**List[NonEmployeeSchemaAttribute]**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of Schema Attributes | List[NonEmployeeSchemaAttribute] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c918085842e69ae018432d22ccb212f' # 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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. +Request will need the following security scope: +'idn:nesr:create' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-non-employee-records-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + | data | **bytearray** | True | + +### Return type +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob | - | +400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-approval +Get List of Non-Employee Approval Requests +This gets a list of non-employee approval requests. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | The identity for whom the request was made. *me* indicates the current user. + 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: **approvalStatus**: *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: **created, modified** + +### Return type +[**List[NonEmployeeApprovalItem]**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of approval items. | List[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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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_approval() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +This gets a list of non-employee records. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-records) + +### 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 | 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + 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: **sourceId**: *eq* + +### Return type +[**List[NonEmployeeRecord]**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee record objects | List[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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_record import NonEmployeeRecord +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +This gets a list of non-employee requests. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-requests) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | True | The identity for whom the request was made. *me* indicates the current user. + 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 | 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + 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: **sourceId**: *eq* + +### Return type +[**List[NonEmployeeRequest]**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of non-employee request objects. | List[NonEmployeeRequest] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_request import NonEmployeeRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + requested_for = 'me' # 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 = 'approvalStatus,firstName' # 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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources) + +### 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 | requested_for | **str** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | non_employee_count | **bool** | (optional) (default to False) | Flag that determines whether the API will return a non-employee count associated with the source. + 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, sourceId** + +### Return type +[**List[NonEmployeeSourceWithNECount]**](../models/non-employee-source-with-ne-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of non-employee source objects. | List[NonEmployeeSourceWithNECount] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +This request will patch a non-employee record. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-employee record id (UUID) + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A patched 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.non_employee_record import NonEmployeeRecord +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # 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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch Non-Employee Source's Schema Attribute +This end-point patches a specific schema attribute for a non-employee SourceId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + 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. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 Non-Employee Source's Schema Attribute + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.non_employee_source import NonEmployeeSource +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, 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") + pprint(results) + 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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem +from sailpoint.beta.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = { + "comment" : "comment" + } # NonEmployeeRejectApprovalDecision | + + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision() + new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, 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") + pprint(results) + 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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.non_employee_record import NonEmployeeRecord +from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808b6ef1d43e016efba0ce470904' # 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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, 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") + pprint(results) + 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/Beta/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md new file mode 100644 index 000000000..c19b46d87 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md @@ -0,0 +1,973 @@ +--- +id: beta-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Notifications', 'BetaNotifications'] +slug: /tools/sdk/python/beta/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'BetaNotifications'] +--- + +# sailpoint.beta.NotificationsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +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/{identityId}` | 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 +Verify domain address via DKIM +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.domain_address import DomainAddress +from sailpoint.beta.models.domain_status_dto import DomainStatusDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + domain_address = { + "domain" : "sailpoint.com" + } # DomainAddress | + + try: + # Verify domain address via DKIM + new_domain_address = DomainAddress() + new_domain_address.from_json(domain_address) + results =NotificationsApi(api_client).create_domain_dkim(new_domain_address) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_domain_dkim(new_domain_address) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-notification-template +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/beta/create-notification-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.template_dto import TemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_template_dto.from_json(template_dto) + results =NotificationsApi(api_client).create_notification_template(new_template_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_notification_template(new_template_dto) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-verified-from-address +Create Verified From Address +Create a new sender email address and initiate verification process. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.email_status_dto import EmailStatusDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + email_status_dto = { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } # EmailStatusDto | + + try: + # Create Verified From Address + new_email_status_dto = EmailStatusDto() + new_email_status_dto.from_json(email_status_dto) + results =NotificationsApi(api_client).create_verified_from_address(new_email_status_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_verified_from_address(new_email_status_dto) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-notification-templates-in-bulk +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/beta/delete-notification-templates-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.template_bulk_delete_dto import TemplateBulkDeleteDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + + try: + # Bulk Delete Notification Templates + new_template_bulk_delete_dto = TemplateBulkDeleteDto() + new_template_bulk_delete_dto.from_json(template_bulk_delete_dto) + NotificationsApi(api_client).delete_notification_templates_in_bulk(new_template_bulk_delete_dto) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_notification_templates_in_bulk(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 +Delete Verified From Address +Delete a verified sender email address + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | # str | + + try: + # Delete Verified From Address + + NotificationsApi(api_client).delete_verified_from_address(id) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_verified_from_address(id) + except Exception as e: + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-dkim-attributes +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/beta/get-dkim-attributes) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.dkim_attributes import DkimAttributes +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get DKIM Attributes + + results =NotificationsApi(api_client).get_dkim_attributes() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_dkim_attributes() + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mail-from-attributes +Get MAIL FROM Attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mail_from_attributes import MailFromAttributes +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_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 + + try: + # Get MAIL FROM Attributes + + results =NotificationsApi(api_client).get_mail_from_attributes(identity_id) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_mail_from_attributes(identity_id) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-notification-template +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/beta/get-notification-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Notification Template + +### Return type +[**List[TemplateDto]**](../models/template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A template object 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.template_dto import TemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template + + try: + # Get Notification Template By Id + + results =NotificationsApi(api_client).get_notification_template(id) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notification_template(id) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-notifications-template-context +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/beta/get-notifications-template-context) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.notification_template_context import NotificationTemplateContext +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get Notification Template Context + + results =NotificationsApi(api_client).get_notifications_template_context() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notifications_template_context() + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-from-addresses +List From Addresses +Retrieve a list of sender email addresses and their verification statuses + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses) + +### 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: **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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.email_status_dto import EmailStatusDto +from pprint import pprint +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 = '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() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-notification-preferences +List Notification Preferences for tenant. +Returns a list of notification preferences for tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-preferences) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | The notification key. + +### Return type +[**List[PreferencesDto]**](../models/preferences-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Return preference for the given notification key. | List[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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.preferences_dto import PreferencesDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key. + + try: + # List Notification Preferences for tenant. + + results =NotificationsApi(api_client).list_notification_preferences(key) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_preferences(key) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-notification-template-defaults +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/beta/list-notification-template-defaults) + +### 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 | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.template_dto_default import TemplateDtoDefault +from pprint import pprint +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 = '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() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-notification-templates +List Notification Templates +This lists the templates that you have modified for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates) + +### 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 | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.template_dto import TemplateDto +from pprint import pprint +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 = '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() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-mail-from-attributes +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/beta/put-mail-from-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.mail_from_attributes import MailFromAttributes +from sailpoint.beta.models.mail_from_attributes_dto import MailFromAttributesDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + mail_from_attributes_dto = { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } # MailFromAttributesDto | + + try: + # Change MAIL FROM domain + new_mail_from_attributes_dto = MailFromAttributesDto() + new_mail_from_attributes_dto.from_json(mail_from_attributes_dto) + results =NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-test-notification +Send Test Notification +Send a Test Notification + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.send_test_notification_request_dto import SendTestNotificationRequestDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_send_test_notification_request_dto.from_json(send_test_notification_request_dto) + NotificationsApi(api_client).send_test_notification(new_send_test_notification_request_dto) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).send_test_notification(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/Beta/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md new file mode 100644 index 000000000..f8425ace1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md @@ -0,0 +1,354 @@ +--- +id: beta-o-auth-clients +title: OAuth_Clients +pagination_label: OAuth_Clients +sidebar_label: OAuth_Clients +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OAuth_Clients', 'BetaOAuth_Clients'] +slug: /tools/sdk/python/beta/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuth_Clients', 'BetaOAuth_Clients'] +--- + +# sailpoint.beta.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/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.create_o_auth_client_request import CreateOAuthClientRequest +from sailpoint.beta.models.create_o_auth_client_response import CreateOAuthClientResponse +from pprint import pprint +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", "http://localhost:67890" ], + "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() + new_create_o_auth_client_request.from_json(create_o_auth_client_request) + results =OAuthClientsApi(api_client).create_oauth_client(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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse +from pprint import pprint +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") + pprint(results) + 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. +Request will require a security scope of +- sp:oauth-client:manage + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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 + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =OAuthClientsApi(api_client).patch_oauth_client(id, 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") + pprint(results) + 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/Beta/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md new file mode 100644 index 000000000..44af467e9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md @@ -0,0 +1,204 @@ +--- +id: beta-org-config +title: Org_Config +pagination_label: Org_Config +sidebar_label: Org_Config +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Org_Config', 'BetaOrg_Config'] +slug: /tools/sdk/python/beta/methods/org-config +tags: ['SDK', 'Software Development Kit', 'Org_Config', 'BetaOrg_Config'] +--- + +# sailpoint.beta.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/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-org-config**](#get-org-config) | **GET** `/org-config` | Get Org configuration settings +[**get-valid-time-zones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones +[**patch-org-config**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property + + +## get-org-config +Get Org configuration settings +Get org configuration with only external (org admin) accessible properties for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-org-config) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.org_config_api import OrgConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.org_config import OrgConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get Org configuration settings + + results =OrgConfigApi(api_client).get_org_config() + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_org_config() + print("The response of OrgConfigApi->get_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-valid-time-zones +Get list of time zones +Get a list of valid time zones that can be set in org configurations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-valid-time-zones) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.org_config_api import OrgConfigApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get list of time zones + + results =OrgConfigApi(api_client).get_valid_time_zones() + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_valid_time_zones() + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(results) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-org-config +Patch an Org configuration property +Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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 | The Org was successfully patched. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.org_config_api import OrgConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.org_config import OrgConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + try: + # Patch an Org configuration property + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =OrgConfigApi(api_client).patch_org_config(new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).patch_org_config(new_json_patch_operation) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(results) + 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/Beta/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md new file mode 100644 index 000000000..6e0778f6b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md @@ -0,0 +1,219 @@ +--- +id: beta-password-configuration +title: Password_Configuration +pagination_label: Password_Configuration +sidebar_label: Password_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Configuration', 'BetaPassword_Configuration'] +slug: /tools/sdk/python/beta/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'Password_Configuration', 'BetaPassword_Configuration'] +--- + +# sailpoint.beta.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/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_org_config import PasswordOrgConfig +from pprint import pprint +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() + new_password_org_config.from_json(password_org_config) + results =PasswordConfigurationApi(api_client).create_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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_org_config import PasswordOrgConfig +from pprint import pprint +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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_org_config import PasswordOrgConfig +from pprint import pprint +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() + new_password_org_config.from_json(password_org_config) + results =PasswordConfigurationApi(api_client).put_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") + pprint(results) + 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/Beta/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md new file mode 100644 index 000000000..6d7c99f70 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md @@ -0,0 +1,239 @@ +--- +id: beta-password-dictionary +title: Password_Dictionary +pagination_label: Password_Dictionary +sidebar_label: Password_Dictionary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Dictionary', 'BetaPassword_Dictionary'] +slug: /tools/sdk/python/beta/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'Password_Dictionary', 'BetaPassword_Dictionary'] +--- + +# sailpoint.beta.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/beta/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/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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/Beta/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md new file mode 100644 index 000000000..2826d01ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md @@ -0,0 +1,355 @@ +--- +id: beta-password-management +title: Password_Management +pagination_label: Password_Management +sidebar_label: Password_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Management', 'BetaPassword_Management'] +slug: /tools/sdk/python/beta/methods/password-management +tags: ['SDK', 'Software Development Kit', 'Password_Management', 'BetaPassword_Management'] +--- + +# sailpoint.beta.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/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-digit-token**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token +[**get-identity-password-change-status**](#get-identity-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-identity-password**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password + + +## create-digit-token +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/beta/create-digit-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_digit_token import PasswordDigitToken +from sailpoint.beta.models.password_digit_token_reset import PasswordDigitTokenReset +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + password_digit_token_reset = { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } # PasswordDigitTokenReset | + + try: + # Generate a digit token + new_password_digit_token_reset = PasswordDigitTokenReset() + new_password_digit_token_reset.from_json(password_digit_token_reset) + results =PasswordManagementApi(api_client).create_digit_token(new_password_digit_token_reset) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).create_digit_token(new_password_digit_token_reset) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_status import PasswordStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | # str | + + try: + # Get Password Change Request Status + + results =PasswordManagementApi(api_client).get_identity_password_change_status(id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_identity_password_change_status(id) + print("The response of PasswordManagementApi->get_identity_password_change_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +is required to call this API. "API authority" refers to a token that only has the "client_credentials" +grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) +grant type will **NOT** work on this endpoint, and a `403 Forbidden` response +will be returned. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_info import PasswordInfo +from sailpoint.beta.models.password_info_query_dto import PasswordInfoQueryDTO +from pprint import pprint +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() + new_password_info_query_dto.from_json(password_info_query_dto) + results =PasswordManagementApi(api_client).query_password_info(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") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-identity-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). + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. +"API authority" refers to a token that only has the "client_credentials" grant type. + +>**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.** + +You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). +To do so, follow these steps: + +1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. + +2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. + +3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: + +```java +import javax.crypto.Cipher; +import java.security.KeyFactory; +import java.security.PublicKey; +import java.security.spec.X509EncodedKeySpec; +import java util.Base64; + +String encrypt(String publicKey, String toEncrypt) throws Exception { + byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); + byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); + return Base64.getEncoder().encodeToString(encryptedBytes); +} + +private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { + PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); + String transformation = "RSA/ECB/PKCS1Padding"; + Cipher cipher = Cipher.getInstance(transformation); + cipher.init(1, key); + return cipher.doFinal(toEncryptBytes); +} +``` + +In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + +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/beta/set-identity-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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_change_request import PasswordChangeRequest +from sailpoint.beta.models.password_change_response import PasswordChangeResponse +from pprint import pprint +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() + new_password_change_request.from_json(password_change_request) + results =PasswordManagementApi(api_client).set_identity_password(new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_identity_password(new_password_change_request) + print("The response of PasswordManagementApi->set_identity_password:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md new file mode 100644 index 000000000..641c02e3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md @@ -0,0 +1,404 @@ +--- +id: beta-password-policies +title: Password_Policies +pagination_label: Password_Policies +sidebar_label: Password_Policies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Policies', 'BetaPassword_Policies'] +slug: /tools/sdk/python/beta/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'Password_Policies', 'BetaPassword_Policies'] +--- + +# sailpoint.beta.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/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto +from pprint import pprint +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() + new_password_policy_v3_dto.from_json(password_policy_v3_dto) + results =PasswordPoliciesApi(api_client).create_password_policy(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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto +from pprint import pprint +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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto +from pprint import pprint +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() + new_password_policy_v3_dto.from_json(password_policy_v3_dto) + results =PasswordPoliciesApi(api_client).set_password_policy(id, 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") + pprint(results) + 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/Beta/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md new file mode 100644 index 000000000..0e3ade205 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md @@ -0,0 +1,374 @@ +--- +id: beta-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', 'BetaPassword_Sync_Groups'] +slug: /tools/sdk/python/beta/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'Password_Sync_Groups', 'BetaPassword_Sync_Groups'] +--- + +# sailpoint.beta.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/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_sync_group import PasswordSyncGroup +from pprint import pprint +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() + new_password_sync_group.from_json(password_sync_group) + results =PasswordSyncGroupsApi(api_client).create_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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_sync_group import PasswordSyncGroup +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_sync_group import PasswordSyncGroup +from pprint import pprint +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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.password_sync_group import PasswordSyncGroup +from pprint import pprint +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() + new_password_sync_group.from_json(password_sync_group) + results =PasswordSyncGroupsApi(api_client).update_password_sync_group(id, 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") + pprint(results) + 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/Beta/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md new file mode 100644 index 000000000..0acadcd76 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md @@ -0,0 +1,289 @@ +--- +id: beta-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', 'BetaPersonal_Access_Tokens'] +slug: /tools/sdk/python/beta/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'Personal_Access_Tokens', 'BetaPersonal_Access_Tokens'] +--- + +# sailpoint.beta.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/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest +from sailpoint.beta.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse +from pprint import pprint +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() + new_create_personal_access_token_request.from_json(create_personal_access_token_request) + results =PersonalAccessTokensApi(api_client).create_personal_access_token(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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_personal_access_token_response import GetPersonalAccessTokenResponse +from pprint import pprint +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") + pprint(results) + 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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.get_personal_access_token_response import GetPersonalAccessTokenResponse +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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 + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =PersonalAccessTokensApi(api_client).patch_personal_access_token(id, 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") + pprint(results) + 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/Beta/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md new file mode 100644 index 000000000..77d30a615 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md @@ -0,0 +1,162 @@ +--- +id: beta-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', 'BetaPublic_Identities_Config'] +slug: /tools/sdk/python/beta/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'Public_Identities_Config', 'BetaPublic_Identities_Config'] +--- + +# sailpoint.beta.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 access approvers, 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/beta/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/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config +[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config + + +## get-public-identity-config +Get Public Identity Config +This gets details of public identity config. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.public_identity_config import PublicIdentityConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get Public Identity Config + + 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") + pprint(results) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-public-identity-config +Update Public Identity Config +This updates the details of public identity config. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.public_identity_config import PublicIdentityConfig +from pprint import pprint +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 Public Identity Config + new_public_identity_config = PublicIdentityConfig() + new_public_identity_config.from_json(public_identity_config) + results =PublicIdentitiesConfigApi(api_client).update_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") + pprint(results) + 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/Beta/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md new file mode 100644 index 000000000..bbffb3687 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md @@ -0,0 +1,107 @@ +--- +id: beta-requestable-objects +title: Requestable_Objects +pagination_label: Requestable_Objects +sidebar_label: Requestable_Objects +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Requestable_Objects', 'BetaRequestable_Objects'] +slug: /tools/sdk/python/beta/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'Requestable_Objects', 'BetaRequestable_Objects'] +--- + +# sailpoint.beta.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/beta/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/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. Support for additional types may be added in the future without notice. + Query | term | **str** | (optional) | 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. + 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. 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. + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.requestable_objects_api import RequestableObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.requestable_object import RequestableObject +from sailpoint.beta.models.requestable_object_request_status import RequestableObjectRequestStatus +from sailpoint.beta.models.requestable_object_type import RequestableObjectType +from pprint import pprint +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.beta.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. Support for additional types may be added in the future without notice. (optional) + + types = [sailpoint.beta.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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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) + 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") + pprint(results) + 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/Beta/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md new file mode 100644 index 000000000..1157c7dd8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md @@ -0,0 +1,583 @@ +--- +id: beta-role-insights +title: Role_Insights +pagination_label: Role_Insights +sidebar_label: Role_Insights +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Role_Insights', 'BetaRole_Insights'] +slug: /tools/sdk/python/beta/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'Role_Insights', 'BetaRole_Insights'] +--- + +# sailpoint.beta.RoleInsightsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +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. +::: +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/beta/create-role-insight-requests) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insights_response import RoleInsightsResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Generate insights for roles + + results =RoleInsightsApi(api_client).create_role_insight_requests() + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).create_role_insight_requests() + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(results) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## download-role-insights-entitlements-changes +Download entitlement insights for a role +This endpoint returns the entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-insights-entitlements-changes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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, ) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(results) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-changes-identities +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/beta/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 + 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insights_identities import RoleInsightsIdentities +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + 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, entitlement_id, ) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insight +Get a single role insight +This endpoint gets role insights information for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insight) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insight import RoleInsight +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + + try: + # Get a single role insight + + results =RoleInsightsApi(api_client).get_role_insight(insight_id) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insight(insight_id) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(results) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights +Get role insights +This method returns detailed role insights for each role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights) + +### 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 | 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insight import RoleInsight +from pprint import pprint +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) + 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() + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(results) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights-current-entitlements +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/beta/get-role-insights-current-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insights_entitlement import RoleInsightsEntitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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, ) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(results) + 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 +Get entitlement insights for a role +This endpoint returns entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-entitlements-changes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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, ) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(results) + 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. +::: +Returns metadata from prior request. +This endpoint returns details of a prior role insights request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-requests) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The role insights request id + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insights_response import RoleInsightsResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id + + try: + # Returns metadata from prior request. + + results =RoleInsightsApi(api_client).get_role_insights_requests(id) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_requests(id) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(results) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights-summary +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/beta/get-role-insights-summary) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_insights_summary import RoleInsightsSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get role insights summary information + + results =RoleInsightsApi(api_client).get_role_insights_summary() + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_summary() + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(results) + 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/Beta/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md new file mode 100644 index 000000000..d6c2f11ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md @@ -0,0 +1,777 @@ +--- +id: beta-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Roles', 'BetaRoles'] +slug: /tools/sdk/python/beta/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'BetaRoles'] +--- + +# sailpoint.beta.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/beta* + +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` | 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 + + +## 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role import Role +from pprint import pprint +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() + new_role.from_json(role) + results =RolesApi(api_client).create_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") + pprint(results) + 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 token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_bulk_delete_request import RoleBulkDeleteRequest +from sailpoint.beta.models.task_result_dto import TaskResultDto +from pprint import pprint +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() + new_role_bulk_delete_request.from_json(role_bulk_delete_request) + results =RolesApi(api_client).delete_bulk_roles(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") + pprint(results) + 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 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role import Role +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assigned-identities +Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role_identity import RoleIdentity +from pprint import pprint +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: + # Identities assigned a Role + + results =RolesApi(api_client).get_role_assigned_identities(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") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-entitlements +List role's Entitlements +This API lists the Entitlements associated with a given role. + +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/beta/get-role-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the containing role + 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, 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role + 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* (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, ) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.role import Role +from pprint import pprint +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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.role import Role +from pprint import pprint +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 + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =RolesApi(api_client).patch_role(id, 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") + pprint(results) + 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/Beta/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md new file mode 100644 index 000000000..c86f3c479 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md @@ -0,0 +1,496 @@ +--- +id: beta-sim-integrations +title: SIM_Integrations +pagination_label: SIM_Integrations +sidebar_label: SIM_Integrations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SIM_Integrations', 'BetaSIM_Integrations'] +slug: /tools/sdk/python/beta/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIM_Integrations', 'BetaSIM_Integrations'] +--- + +# sailpoint.beta.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/beta* + +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 +Create new SIM integration +Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.beta.models.sim_integration_details import SimIntegrationDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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() + new_sim_integration_details.from_json(sim_integration_details) + results =SIMIntegrationsApi(api_client).create_sim_integration(new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sim-integration +Delete a SIM integration +Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the integration to delete. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sim-integration +Get a SIM integration details. +Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the integration. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + + try: + # Get a SIM integration details. + + results =SIMIntegrationsApi(api_client).get_sim_integration(id) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sim-integrations +List the existing SIM integrations. +List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integrations) + +### Parameters +This endpoint does not need any parameter. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List the existing SIM integrations. + + results =SIMIntegrationsApi(api_client).get_sim_integrations() + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations() + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-before-provisioning-rule +Patch a SIM beforeProvisioningRule attribute. +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-before-provisioning-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | SIM integration id + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch import JsonPatch +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch() + new_json_patch.from_json(json_patch) + results =SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sim-attributes +Patch a SIM attribute. +Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sim-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | SIM integration id + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch import JsonPatch +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM + + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch() + new_json_patch.from_json(json_patch) + results =SIMIntegrationsApi(api_client).patch_sim_attributes(id, new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-sim-integration +Update an existing SIM integration +Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the integration. + 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.beta.models.sim_integration_details import SimIntegrationDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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() + new_sim_integration_details.from_json(sim_integration_details) + results =SIMIntegrationsApi(api_client).put_sim_integration(id, new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(results) + 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/Beta/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md new file mode 100644 index 000000000..22ccd4f26 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md @@ -0,0 +1,1292 @@ +--- +id: beta-sod-policies +title: SOD_Policies +pagination_label: SOD_Policies +sidebar_label: SOD_Policies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SOD_Policies', 'BetaSOD_Policies'] +slug: /tools/sdk/python/beta/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SOD_Policies', 'BetaSOD_Policies'] +--- + +# sailpoint.beta.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/beta* + +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 a SOD policy +[**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-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 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy import SodPolicy +from pprint import pprint +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() + new_sod_policy.from_json(sod_policy) + results =SODPoliciesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # 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. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) + + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(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 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete SOD policy schedule +This deletes schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # 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) + # 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 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Download custom violation report +This allows to download a specified named violation report for a given report reference. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-default-violation-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Download violation report +This allows to download a violation report for a given report reference. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + 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 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.report_result_reference import ReportResultReference +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the object reference 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy import SodPolicy +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + + try: + # Get SOD policy by ID + + results =SODPoliciesApi(api_client).get_sod_policy(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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. +Requires the role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the object reference to retrieve. + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD policy ID. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + + try: + # Get SOD policy schedule + + results =SODPoliciesApi(api_client).get_sod_policy_schedule(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") + pprint(results) + 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 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get violation report run status +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.report_result_reference import ReportResultReference +from pprint import pprint +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) + # 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") + pprint(results) + 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 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the object 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.report_result_reference import ReportResultReference +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + + try: + # Get SOD violation report status + + results =SODPoliciesApi(api_client).get_sod_violation_report_status(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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sod-policies +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy import SodPolicy +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Patch a SOD policy +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/beta/patch-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy being modified. + Body | request_body | **[]object** | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy import SodPolicy +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + request_body = [{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[object] | 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 + request_body = [{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[object] | 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 a SOD policy + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =SODPoliciesApi(api_client).patch_sod_policy(id, new_request_body) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_request_body) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update SOD Policy schedule +This updates schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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 | SOD policy by ID. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } # SodPolicySchedule | + + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule() + new_sod_policy_schedule.from_json(sod_policy_schedule) + results =SODPoliciesApi(api_client).put_policy_schedule(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sod_policy import SodPolicy +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # 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() + new_sod_policy.from_json(sod_policy) + results =SODPoliciesApi(api_client).put_sod_policy(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-sod-all-policies-for-org +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +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. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.multi_policy_request import MultiPolicyRequest +from sailpoint.beta.models.report_result_reference import ReportResultReference +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + multi_policy_request = { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } # 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") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +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. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.report_result_reference import ReportResultReference +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # 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) + # 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") + pprint(results) + 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/Beta/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md new file mode 100644 index 000000000..a7e47898a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md @@ -0,0 +1,118 @@ +--- +id: beta-sod-violations +title: SOD_Violations +pagination_label: SOD_Violations +sidebar_label: SOD_Violations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SOD_Violations', 'BetaSOD_Violations'] +slug: /tools/sdk/python/beta/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SOD_Violations', 'BetaSOD_Violations'] +--- + +# sailpoint.beta.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/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. + + +## start-predict-sod-violations +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +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. + +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sod_violations_api import SODViolationsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.identity_with_new_access import IdentityWithNewAccess +from sailpoint.beta.models.violation_prediction import ViolationPrediction +from pprint import pprint +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() + new_identity_with_new_access.from_json(identity_with_new_access) + results =SODViolationsApi(api_client).start_predict_sod_violations(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") + pprint(results) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md new file mode 100644 index 000000000..9a103f4b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md @@ -0,0 +1,471 @@ +--- +id: beta-sp-config +title: SP_Config +pagination_label: SP_Config +sidebar_label: SP_Config +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SP_Config', 'BetaSP_Config'] +slug: /tools/sdk/python/beta/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SP_Config', 'BetaSP_Config'] +--- + +# sailpoint.beta.SPConfigApi + Import and export configuration for some objects between tenants. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.export_payload import ExportPayload +from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob +from pprint import pprint +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() + new_export_payload.from_json(export_payload) + results =SPConfigApi(api_client).export_sp_config(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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus +from pprint import pprint +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) + # 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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.import_options import ImportOptions +from sailpoint.beta.models.sp_config_job import SpConfigJob +from pprint import pprint +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.beta.ImportOptions() # ImportOptions | (optional) + + try: + # Initiates configuration objects import job + + results =SPConfigApi(api_client).import_sp_config(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") + pprint(results) + 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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sp_config_object import SpConfigObject +from pprint import pprint +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") + pprint(results) + 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/Beta/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md new file mode 100644 index 000000000..46b0789cb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md @@ -0,0 +1,356 @@ +--- +id: beta-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', 'BetaSearch_Attribute_Configuration'] +slug: /tools/sdk/python/beta/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'Search_Attribute_Configuration', 'BetaSearch_Attribute_Configuration'] +--- + +# sailpoint.beta.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/beta* + +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 and attribute promotion configuration in the Link ObjectConfig. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig +from pprint import pprint +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() + new_search_attribute_config.from_json(search_attribute_config) + results =SearchAttributeConfigurationApi(api_client).create_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") + pprint(results) + 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/beta/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. | | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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 associates currently configured in Identity Security Cloud (ISC). +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-search-attribute-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[SearchAttributeConfig]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of attribute configurations in ISC. | List[SearchAttributeConfig] | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + 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() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(results) + 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/beta/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. + +### Return type +[**List[SearchAttributeConfig]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Specific attribute configuration in IdentityNow. | List[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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + + try: + # Get Extended Search Attribute + + results =SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(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") + pprint(results) + 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/beta/patch-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the extended 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 | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, 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") + pprint(results) + 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/Beta/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md new file mode 100644 index 000000000..f489d6c2a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md @@ -0,0 +1,379 @@ +--- +id: beta-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Segments', 'BetaSegments'] +slug: /tools/sdk/python/beta/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'BetaSegments'] +--- + +# sailpoint.beta.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/beta* + +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. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.segment import Segment +from pprint import pprint +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() + new_segment.from_json(segment) + results =SegmentsApi(api_client).create_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") + pprint(results) + 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:** Segment deletion may take some time to go into effect. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.segment import Segment +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(results) + 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. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.segment import Segment +from pprint import pprint +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") + pprint(results) + 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. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.segment import Segment +from pprint import pprint +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 + 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() + new_request_body.from_json(request_body) + results =SegmentsApi(api_client).patch_segment(id, 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") + pprint(results) + 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/Beta/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md new file mode 100644 index 000000000..bd20e921a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md @@ -0,0 +1,724 @@ +--- +id: beta-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', 'BetaService_Desk_Integration'] +slug: /tools/sdk/python/beta/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'Service_Desk_Integration', 'BetaService_Desk_Integration'] +--- + +# sailpoint.beta.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/beta* + +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-list**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**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-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/beta/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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto() + new_service_desk_integration_dto.from_json(service_desk_integration_dto) + results =ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of Service Desk integration to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Service Desk integration with the given ID successfully deleted | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to get + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto with the given ID | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + + try: + # Get a Service Desk integration + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-list +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list) + +### 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 | 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + 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[ServiceDeskIntegrationDto]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of ServiceDeskIntegrationDto | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + + try: + # List existing Service Desk integrations + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the Service Desk integration template to get + +### Return type +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + + try: + # Service Desk integration template by scriptName + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-types) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[ServiceDeskIntegrationTemplateType]**](../models/service-desk-integration-template-type) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with an array of the currently supported Service Desk integration types. | List[ServiceDeskIntegrationTemplateType] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Service Desk integration types + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-check-details) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get the time check configuration + + results =ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to update + Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | 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. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto as updated | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.beta.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest() + new_patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + results =ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to update + Body | service_desk_integration_dto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto as updated | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto() + new_service_desk_integration_dto.from_json(service_desk_integration_dto) + results =ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-status-check-details) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | queued_check_config_details | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails() + new_queued_check_config_details.from_json(queued_check_config_details) + results =ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md new file mode 100644 index 000000000..bc70c9f55 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md @@ -0,0 +1,152 @@ +--- +id: beta-source-usages +title: Source_Usages +pagination_label: Source_Usages +sidebar_label: Source_Usages +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source_Usages', 'BetaSource_Usages'] +slug: /tools/sdk/python/beta/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'Source_Usages', 'BetaSource_Usages'] +--- + +# sailpoint.beta.SourceUsagesApi + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-by-source-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of IDN source + +### Return type +[**SourceUsageStatus**](../models/source-usage-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.source_usages_api import SourceUsagesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_usage_status import SourceUsageStatus +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-usages-by-source-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of IDN source + 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 | 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: **date** + +### Return type +[**List[SourceUsage]**](../models/source-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of source usage insights for past 12 months. | List[SourceUsage] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.source_usages_api import SourceUsagesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_usage import SourceUsage +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md new file mode 100644 index 000000000..fa0e45044 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md @@ -0,0 +1,3254 @@ +--- +id: beta-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Sources', 'BetaSources'] +slug: /tools/sdk/python/beta/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'BetaSources'] +--- + +# sailpoint.beta.SourcesApi + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. +[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete**](#delete) | **DELETE** `/sources/{id}` | Delete Source by ID +[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{sourceId}/remove-accounts` | Remove All Accounts in a Source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-correlation-config**](#get-correlation-config) | **GET** `/sources/{sourceId}/correlation-config` | Get Source Correlation Configuration +[**get-native-change-detection-config**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID +[**get-source-accounts-schema**](#get-source-accounts-schema) | **GET** `/sources/{sourceId}/schemas/accounts` | Downloads source accounts schema template +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{sourceId}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-entitlements-schema**](#get-source-entitlements-schema) | **GET** `/sources/{sourceId}/schemas/entitlements` | Downloads source entitlements schema template +[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts**](#import-accounts) | **POST** `/sources/{sourceId}/load-accounts` | Account Aggregation +[**import-entitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement Aggregation +[**import-source-accounts-schema**](#import-source-accounts-schema) | **POST** `/sources/{sourceId}/schemas/accounts` | Uploads source accounts schema template +[**import-source-connector-file**](#import-source-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-source-entitlements-schema**](#import-source-entitlements-schema) | **POST** `/sources/{sourceId}/schemas/entitlements` | Uploads source entitlements schema template +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**peek-resource-objects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**ping-cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{sourceId}/correlation-config` | Update Source Correlation Configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**sync-attributes-for-source**](#sync-attributes-for-source) | **POST** `/sources/{sourceId}/synchronize-attributes` | Synchronize single source attributes. +[**test-source-configuration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**test-source-connection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **PUT** `/sources/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | provisioning_policy_dto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +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() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).create_provisioning_policy(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | source | [**Source**](../models/source) | True | + Query | provision_as_csv | **bool** | (optional) | 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. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | 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. | Source | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source import Source +from pprint import pprint +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() + new_source.from_json(source) + results =SourcesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Body | model_schema | [**ModelSchema**](../models/model-schema) | True | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The schema was successfully created on the specified source. | ModelSchema | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +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.beta.ModelSchema() # ModelSchema | + + try: + # Create Schema on Source + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).create_source_schema(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete +Delete Source by ID +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}` +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**Delete202Response**](../models/delete202-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | Delete202Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.delete202_response import Delete202Response +from pprint import pprint +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(id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete(id) + print("The response of SourcesApi->delete:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->delete: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-accounts-async +Remove All Accounts in a Source +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-accounts-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The source id + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. Returns task result details of removal request. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_result_dto import TaskResultDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id + + try: + # Remove All Accounts in a Source + + results =SourcesApi(api_client).delete_accounts_async(source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_accounts_async(source_id) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-native-change-detection-config +Delete Native Change Detection Configuration +Deletes the native change detection configuration for the source specified by the given ID. +A token with API, or ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-native-change-detection-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The source id + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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: + # Delete Native Change Detection Configuration + + SourcesApi(api_client).delete_native_change_detection_config(source_id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).delete_native_change_detection_config(source_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.usage_type import UsageType +from pprint import pprint +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.beta.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, 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) +``` + + + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | schema_id | **str** | True | The Schema ID. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## get-correlation-config +Get Source Correlation Configuration +This API returns the existing correlation configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-correlation-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The source id + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Correlation configuration for a source | CorrelationConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.correlation_config import CorrelationConfig +from pprint import pprint +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: + # Get Source Correlation Configuration + + results =SourcesApi(api_client).get_correlation_config(source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_correlation_config(source_id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-native-change-detection-config +Native Change Detection Configuration +This API returns the existing native change detection configuration for a source specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-native-change-detection-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The source id + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Native change detection configuration for a source | NativeChangeDetectionConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.native_change_detection_config import NativeChangeDetectionConfig +from pprint import pprint +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: + # Native Change Detection Configuration + + results =SourcesApi(api_client).get_native_change_detection_config(source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_native_change_detection_config(source_id) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.beta.models.usage_type import UsageType +from pprint import pprint +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.beta.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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source object. | Source | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source import Source +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-accounts-schema +Downloads source accounts schema template + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-accounts-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully downloaded the file | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + + try: + # Downloads source accounts schema template + + SourcesApi(api_client).get_source_accounts_schema(source_id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_source_accounts_schema(source_id) + except Exception as e: + print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-attr-sync-config +Attribute Sync Config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-attr-sync-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Attribute synchronization configuration for a source | AttrSyncSourceConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.attr_sync_source_config import AttrSyncSourceConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + + try: + # Attribute Sync Config + + results =SourcesApi(api_client).get_source_attr_sync_config(id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_attr_sync_config(id) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-config +Gets source config with language translations +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Detail object | ConnectorDetail | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.connector_detail import ConnectorDetail +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | The Source id # str | The Source id + locale = 'locale_example' # 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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-entitlement-request-config +Get Source Entitlement Request Configuration +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. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-entitlement-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_entitlement_request_config import SourceEntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + + try: + # Get Source Entitlement Request Configuration + + results =SourcesApi(api_client).get_source_entitlement_request_config(source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_entitlement_request_config(source_id) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-entitlements-schema +Downloads source entitlements schema template + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-entitlements-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Query | schema_name | **str** | (optional) | Name of entitlement schema + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully downloaded the file | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_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_source_entitlements_schema(source_id, ) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_source_entitlements_schema(source_id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | schema_id | **str** | True | The Schema ID. + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested Schema was successfully retrieved. | ModelSchema | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schemas) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Query | include_types | **str** | (optional) | 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. + Query | include_names | **str** | (optional) | A comma-separated list of schema names to filter result. + +### Return type +[**List[ModelSchema]**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The schemas were successfully retrieved. | List[ModelSchema] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-accounts +Account Aggregation +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-accounts) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + | file | **bytearray** | (optional) | The CSV file containing the source accounts to aggregate. + | disable_optimization | **str** | (optional) | Use this flag to reprocess every account whether or not the data has changed. + +### Return type +[**LoadAccountsTask**](../models/load-accounts-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Aggregate Accounts Task | LoadAccountsTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.load_accounts_task import LoadAccountsTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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(source_id, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts(source_id, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-entitlements +Entitlement Aggregation +Starts an entitlement aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + | file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate. + +### Return type +[**LoadEntitlementTask**](../models/load-entitlement-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Aggregate Entitlements Task | LoadEntitlementTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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: + # Entitlement Aggregation + + results =SourcesApi(api_client).import_entitlements(source_id, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_entitlements(source_id, file) + print("The response of SourcesApi->import_entitlements:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-source-accounts-schema +Uploads source accounts schema template +This API uploads a source schema template file to configure a source's account attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-accounts-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + | file | **bytearray** | (optional) | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully uploaded the file | ModelSchema | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_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_source_accounts_schema(source_id, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_source_accounts_schema(source_id, file) + print("The response of SourcesApi->import_source_accounts_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-source-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-connector-file) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + | file | **bytearray** | (optional) | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Uploaded the file successfully and sent all post-upload events | Source | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source import Source +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # 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_source_connector_file(source_id, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_source_connector_file(source_id, file) + print("The response of SourcesApi->import_source_connector_file:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-source-entitlements-schema +Uploads source entitlements schema template +This API uploads a source schema template file to configure a source's entitlement attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-entitlements-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Query | schema_name | **str** | (optional) | Name of entitlement schema + | file | **bytearray** | (optional) | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully uploaded the file | ModelSchema | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_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_source_entitlements_schema(source_id, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_source_entitlements_schema(source_id, schema_name, file) + print("The response of SourcesApi->import_source_entitlements_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-uncorrelated-accounts +Process Uncorrelated Accounts +File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-uncorrelated-accounts) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + | file | **bytearray** | (optional) | + +### Return type +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Uncorrelated Accounts Task | LoadUncorrelatedAccountsTask | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id + file = None # bytearray | (optional) # bytearray | (optional) + + try: + # Process Uncorrelated Accounts + + results =SourcesApi(api_client).import_uncorrelated_accounts(source_id, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_uncorrelated_accounts(source_id, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-provisioning-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**List[ProvisioningPolicyDto]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of ProvisioningPolicyDto objects | List[ProvisioningPolicyDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sources) + +### 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, 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* **modified**: *eq* **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* + 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: **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** + Query | for_subadmin | **str** | (optional) | 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. + Query | include_idn_source | **bool** | (optional) (default to False) | Include the IdentityNow source in the response. + +### Return type +[**List[Source]**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Source objects | List[Source] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source import Source +from pprint import pprint +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* **modified**: *eq* **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* **modified**: *eq* **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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## peek-resource-objects +Peek source connector's resource objects +Retrieves a sample of data returned from account and group aggregation requests. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/peek-resource-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source + Body | resource_objects_request | [**ResourceObjectsRequest**](../models/resource-objects-request) | True | + +### Return type +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.resource_objects_request import ResourceObjectsRequest +from sailpoint.beta.models.resource_objects_response import ResourceObjectsResponse +from pprint import pprint +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() + new_resource_objects_request.from_json(resource_objects_request) + results =SourcesApi(api_client).peek_resource_objects(source_id, new_resource_objects_request) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).peek_resource_objects(source_id, new_resource_objects_request) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + +## ping-cluster +Ping cluster for source connector +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of pinging connection with the source connector. | StatusResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.status_response import StatusResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-correlation-config +Update Source Correlation Configuration +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-correlation-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The source id + Body | correlation_config | [**CorrelationConfig**](../models/correlation-config) | True | + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated correlation configuration for a source | CorrelationConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.correlation_config import CorrelationConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_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() + new_correlation_config.from_json(correlation_config) + results =SourcesApi(api_client).put_correlation_config(source_id, new_correlation_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_correlation_config(source_id, new_correlation_config) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-native-change-detection-config +Update Native Change Detection Configuration +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The source id + Body | native_change_detection_config | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | True | + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated native change detection configuration for a source | NativeChangeDetectionConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.native_change_detection_config import NativeChangeDetectionConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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() + new_native_change_detection_config.from_json(native_change_detection_config) + results =SourcesApi(api_client).put_native_change_detection_config(source_id, new_native_change_detection_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_native_change_detection_config(source_id, new_native_change_detection_config) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + Body | provisioning_policy_dto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.beta.models.usage_type import UsageType +from pprint import pprint +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.beta.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() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source +Update Source (Full) +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. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + Body | source | [**Source**](../models/source) | True | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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. | Source | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source import Source +from pprint import pprint +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() + new_source.from_json(source) + results =SourcesApi(api_client).put_source(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source-attr-sync-config +Update Attribute Sync Config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source-attr-sync-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + Body | attr_sync_source_config | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | True | + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated attribute synchronization configuration for a source | AttrSyncSourceConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.attr_sync_source_config import AttrSyncSourceConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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() + new_attr_sync_source_config.from_json(attr_sync_source_config) + results =SourcesApi(api_client).put_source_attr_sync_config(id, new_attr_sync_source_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source_attr_sync_config(id, new_attr_sync_source_config) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | schema_id | **str** | True | The Schema ID. + Body | model_schema | [**ModelSchema**](../models/model-schema) | True | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema was successfully replaced. | ModelSchema | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +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.beta.ModelSchema() # ModelSchema | + + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).put_source_schema(source_id, schema_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sync-attributes-for-source +Synchronize single source attributes. +This end-point performs attribute synchronization for a selected source. +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-attributes-for-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**SourceSyncJob**](../models/source-sync-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | A Source Sync job | SourceSyncJob | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_sync_job import SourceSyncJob +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = 'source_id_example' # str | The Source id # str | The Source id + + try: + # Synchronize single source attributes. + + results =SourcesApi(api_client).sync_attributes_for_source(source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).sync_attributes_for_source(source_id) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-source-configuration +Test configuration for source connector +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. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of testing source connector configuration with response from it. | StatusResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.status_response import StatusResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-source-connection +Check connection for source connector. +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of checking connection to the source connector with response from it. | StatusResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.status_response import StatusResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policies-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + Body | provisioning_policy_dto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**List[ProvisioningPolicyDto]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of the ProvisioningPolicyDto was successfully replaced. | List[ProvisioningPolicyDto] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.beta.models.usage_type import UsageType +from pprint import pprint +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.beta.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source +Update Source (Partial) +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. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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). + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they are not decryptable in Identity Security Cloud cloud-based services, per ISC security design. | Source | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.source import Source +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-entitlement-request-config +Update Source Entitlement Request Configuration +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. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-entitlement-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | source_entitlement_request_config | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | True | + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.source_entitlement_request_config import SourceEntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + 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() + new_source_entitlement_request_config.from_json(source_entitlement_request_config) + results =SourcesApi(api_client).update_source_entitlement_request_config(source_id, new_source_entitlement_request_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source_entitlement_request_config(source_id, new_source_entitlement_request_config) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +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/beta/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 +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema was successfully updated. | ModelSchema | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.model_schema import ModelSchema +from pprint import pprint +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. + [{op=replace, path=/displayAttribute, value={new-display-attribute=null}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schema(source_id, schema_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md new file mode 100644 index 000000000..b544925f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md @@ -0,0 +1,512 @@ +--- +id: beta-suggested-entitlement-description +title: Suggested_Entitlement_Description +pagination_label: Suggested_Entitlement_Description +sidebar_label: Suggested_Entitlement_Description +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Suggested_Entitlement_Description', 'BetaSuggested_Entitlement_Description'] +slug: /tools/sdk/python/beta/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'Suggested_Entitlement_Description', 'BetaSuggested_Entitlement_Description'] +--- + +# sailpoint.beta.SuggestedEntitlementDescriptionApi + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-sed-batch-stats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**get-sed-batches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**list-seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**patch-sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**submit-sed-approval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**submit-sed-assignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + + +## get-sed-batch-stats +Submit Sed Batch Stats Request +Submit Sed Batch Stats Request. + +Submits batchId in the path param `(e.g. {batchId}/stats)`. +API responses with stats of the batchId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batch-stats) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | batch_id | **str** | True | Batch Id + +### Return type +[**SedBatchStats**](../models/sed-batch-stats) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Stats of Sed batch. | SedBatchStats | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed_batch_stats import SedBatchStats +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sed-batches +List Sed Batch Request +List Sed Batches. +API responses with Sed Batch Status + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SedBatchStatus**](../models/sed-batch-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of batch | SedBatchStatus | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed_batch_status import SedBatchStatus +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-seds +List Suggested Entitlement Descriptions +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 + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-seds) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) | 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. + 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *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: **displayName, sourceName, status** + Query | count | **bool** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. + Query | count_only | **bool** | (optional) | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. + Query | requested_by_anyone | **bool** | (optional) | 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 + Query | show_pending_status_only | **bool** | (optional) | Will limit records to items that are in \"suggested\" or \"approved\" status + +### Return type +[**List[Sed]**](../models/sed) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Suggested Entitlement Details | List[Sed] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed import Sed +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + limit = limit=25 # int | 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) # int | 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) + 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 = count=true # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + count_only = count-only=true # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + requested_by_anyone = requested-by-anyone=true # 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) # 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) + show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) + + 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, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sed +Patch Suggested Entitlement Description +Patch Suggested Entitlement Description + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sed) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | id is sed id + Body | sed_patch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request + +### Return type +[**Sed**](../models/sed) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | detail of patched sed | Sed | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed import Sed +from sailpoint.beta.models.sed_patch import SedPatch +from pprint import pprint +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 + [sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + + try: + # Patch Suggested Entitlement Description + new_sed_patch = SedPatch() + new_sed_patch.from_json(sed_patch) + results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-sed-approval +Submit Bulk Approval Request +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sed_approval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval + +### Return type +[**List[SedApprovalStatus]**](../models/sed-approval-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of SED Approval Status | List[SedApprovalStatus] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed_approval import SedApproval +from sailpoint.beta.models.sed_approval_status import SedApprovalStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + + try: + # Submit Bulk Approval Request + new_sed_approval = SedApproval() + new_sed_approval.from_json(sed_approval) + results =SuggestedEntitlementDescriptionApi(api_client).submit_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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-sed-assignment +Submit Sed Assignment Request +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 + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-assignment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sed_assignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request + +### Return type +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Sed Assignment Response | SedAssignmentResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed_assignment import SedAssignment +from sailpoint.beta.models.sed_assignment_response import SedAssignmentResponse +from pprint import pprint +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() + new_sed_assignment.from_json(sed_assignment) + results =SuggestedEntitlementDescriptionApi(api_client).submit_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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-sed-batch-request +Submit Sed Batch Request +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 + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-batch-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sed_batch_request | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request + +### Return type +[**SedBatchResponse**](../models/sed-batch-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Sed Batch Response | SedBatchResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.sed_batch_request import SedBatchRequest +from sailpoint.beta.models.sed_batch_response import SedBatchResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md new file mode 100644 index 000000000..ba9664b40 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md @@ -0,0 +1,621 @@ +--- +id: beta-tagged-objects +title: Tagged_Objects +pagination_label: Tagged_Objects +sidebar_label: Tagged_Objects +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tagged_Objects', 'BetaTagged_Objects'] +slug: /tools/sdk/python/beta/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'Tagged_Objects', 'BetaTagged_Objects'] +--- + +# sailpoint.beta.TaggedObjectsApi + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of object to delete tags from. +Path | id | **str** | True | The ID of the object to delete tags from. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tags-to-many-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_tagged_object | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + try: + # Remove Tags from Multiple Objects + new_bulk_tagged_object = BulkTaggedObject() + new_bulk_tagged_object.from_json(bulk_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_tagged_object) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_tagged_object) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to retrieve. +Path | id | **str** | True | The ID of the object reference to retrieve. + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tagged object by type and ID. | TaggedObject | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tagged_object import TaggedObject +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tagged-objects) + +### 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + +### Return type +[**List[TaggedObject]**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tagged objects. | List[TaggedObject] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tagged_object import TaggedObject +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tagged-objects-by-type) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to retrieve. + 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: **objectRef.id**: *eq* **objectRef.type**: *eq* + +### Return type +[**List[TaggedObject]**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tagged objects for specified type. | List[TaggedObject] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tagged_object import TaggedObject +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to update. +Path | id | **str** | True | The ID of the object reference to update. + Body | tagged_object | [**TaggedObject**](../models/tagged-object) | True | + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tagged object by type and ID. | TaggedObject | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tagged_object import TaggedObject +from pprint import pprint +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() + new_tagged_object.from_json(tagged_object) + results =TaggedObjectsApi(api_client).put_tagged_object(type, id, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tag-to-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | tagged_object | [**TaggedObject**](../models/tagged-object) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tagged_object import TaggedObject +from pprint import pprint +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() + new_tagged_object.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_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) +``` + + + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tags-to-many-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_tagged_object | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type +[**BulkTaggedObject**](../models/bulk-tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | BulkTaggedObject | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + try: + # Tag Multiple Objects + new_bulk_tagged_object = BulkTaggedObject() + new_bulk_tagged_object.from_json(bulk_tagged_object) + results =TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_tagged_object) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_tagged_object) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md new file mode 100644 index 000000000..89c4307e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md @@ -0,0 +1,291 @@ +--- +id: beta-tags +title: Tags +pagination_label: Tags +sidebar_label: Tags +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tags', 'BetaTags'] +slug: /tools/sdk/python/beta/methods/tags +tags: ['SDK', 'Software Development Kit', 'Tags', 'BetaTags'] +--- + +# sailpoint.beta.TagsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-tag**](#create-tag) | **POST** `/tags` | Create Tag +[**delete-tag-by-id**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete Tag +[**get-tag-by-id**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id +[**list-tags**](#list-tags) | **GET** `/tags` | List Tags + + +## create-tag +Create Tag +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-tag) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | tag | [**Tag**](../models/tag) | True | + +### Return type +[**Tag**](../models/tag) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created tag. | Tag | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tag import Tag +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + tag = { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "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" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } # Tag | + + try: + # Create Tag + new_tag = Tag() + new_tag.from_json(tag) + results =TagsApi(api_client).create_tag(new_tag) + # Below is a request that includes all optional parameters + # results = TagsApi(api_client).create_tag(new_tag) + print("The response of TagsApi->create_tag:\n") + pprint(results) + except Exception as e: + print("Exception when calling TagsApi->create_tag: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-tag-by-id +Delete Tag +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tag-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the object reference 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete. + + try: + # Delete Tag + + TagsApi(api_client).delete_tag_by_id(id) + # Below is a request that includes all optional parameters + # TagsApi(api_client).delete_tag_by_id(id) + except Exception as e: + print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-tag-by-id +Get Tag By Id +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tag-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the object reference to retrieve. + +### Return type +[**Tag**](../models/tag) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tag | Tag | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tag import Tag +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + + try: + # Get Tag By Id + + results =TagsApi(api_client).get_tag_by_id(id) + # Below is a request that includes all optional parameters + # results = TagsApi(api_client).get_tag_by_id(id) + print("The response of TagsApi->get_tag_by_id:\n") + pprint(results) + except Exception as e: + print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tags +List Tags +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tags) + +### 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, 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: **id, name, created, modified** + +### Return type +[**List[Tag]**](../models/tag) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tags. | List[Tag] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tag import Tag +from pprint import pprint +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 \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # 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,-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** (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** (optional) + + try: + # List Tags + + results =TagsApi(api_client).list_tags() + # Below is a request that includes all optional parameters + # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) + print("The response of TagsApi->list_tags:\n") + pprint(results) + except Exception as e: + print("Exception when calling TagsApi->list_tags: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md new file mode 100644 index 000000000..9ecd283d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md @@ -0,0 +1,350 @@ +--- +id: beta-task-management +title: Task_Management +pagination_label: Task_Management +sidebar_label: Task_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Task_Management', 'BetaTask_Management'] +slug: /tools/sdk/python/beta/methods/task-management +tags: ['SDK', 'Software Development Kit', 'Task_Management', 'BetaTask_Management'] +--- + +# sailpoint.beta.TaskManagementApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-pending-task-headers**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**get-pending-tasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**get-task-status**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID +[**get-task-status-list**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List +[**update-task-status**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID + + +## get-pending-task-headers +Retrieve Pending Task List Headers +Responds with headers only for list of task statuses for pending tasks. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-task-headers) + +### 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. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Retrieve headers for a list of TaskStatus for pending tasks. | | - | +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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + + try: + # Retrieve Pending Task List Headers + + TaskManagementApi(api_client).get_pending_task_headers() + # Below is a request that includes all optional parameters + # TaskManagementApi(api_client).get_pending_task_headers(offset, limit, count) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-pending-tasks +Retrieve Pending Task Status List +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) + +### 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. + +### Return type +[**List[TaskStatus]**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a list of TaskStatus for pending tasks. | List[TaskStatus] | - | +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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_status import TaskStatus +from pprint import pprint +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) + + try: + # Retrieve Pending Task Status List + + results =TaskManagementApi(api_client).get_pending_tasks() + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-task-status +Get Task Status by ID +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Task ID. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus | - | +403 | Forbidden, generally due to a lack of security rights | | - | +404 | TaskStatus with the given id was not found. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + + try: + # Get Task Status by ID + + results =TaskManagementApi(api_client).get_task_status(id) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status(id) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-task-status-list +Retrieve Task Status List +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/beta/get-pending-tasks) endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status-list) + +### 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *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: **created** + +### Return type +[**List[TaskStatus]**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a TaskStatus for the task with the given task ID. | List[TaskStatus] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.task_status import TaskStatus +from pprint import pprint +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 = '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() + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-task-status +Update Task Status by ID +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-task-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Task ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates the PATCH operation succeeded, and the API returns the updated task object. | TaskStatus | - | +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 | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + + try: + # Update Task Status by ID + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md new file mode 100644 index 000000000..94627bbc1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md @@ -0,0 +1,78 @@ +--- +id: beta-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tenant', 'BetaTenant'] +slug: /tools/sdk/python/beta/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant'] +--- + +# sailpoint.beta.TenantApi + API for reading tenant details. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. + + +## get-tenant +Get Tenant Information. +This rest endpoint can be used to retrieve tenant details. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**Tenant**](../models/tenant) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tenant Info | Tenant | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.tenant_api import TenantApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tenant import Tenant +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md new file mode 100644 index 000000000..54a90bd7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md @@ -0,0 +1,348 @@ +--- +id: beta-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Transforms', 'BetaTransforms'] +slug: /tools/sdk/python/beta/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'BetaTransforms'] +--- + +# sailpoint.beta.TransformsApi + Operations for creating, managing, and deleting transforms. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **POST** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **GET** `/transforms` | List transforms +[**update-transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +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. A token with transform write authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | transform | [**Transform**](../models/transform) | True | The transform to be created. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Indicates the transform was successfully created and returns its representation. | TransformRead | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.transform import Transform +from sailpoint.beta.models.transform_read import TransformRead +from pprint import pprint +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() + new_transform.from_json(transform) + results =TransformsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-transform +Delete a transform +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. +A token with transform delete authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. +A token with transform read authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform to retrieve + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Transform with the given ID | TransformRead | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.transform_read import TransformRead +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. +A token with transforms-list read authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-transforms) + +### 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 | name | **str** | (optional) | Name of the transform to retrieve from the list. + 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: **internal**: *eq* **name**: *eq, sw* + +### Return type +[**List[TransformRead]**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of transforms matching the given criteria. | List[TransformRead] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.transform_read import TransformRead +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-transform +Update a transform +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. +A token with transform write authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform to update + Body | transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.transform import Transform +from sailpoint.beta.models.transform_read import TransformRead +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md new file mode 100644 index 000000000..64fb2b69a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md @@ -0,0 +1,787 @@ +--- +id: beta-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Triggers', 'BetaTriggers'] +slug: /tools/sdk/python/beta/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'BetaTriggers'] +--- + +# sailpoint.beta.TriggersApi + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-trigger-invocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**create-subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription +[**delete-subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription +[**list-subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses +[**list-triggers**](#list-triggers) | **GET** `/triggers` | List Triggers +[**patch-subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation +[**test-subscription-filter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**update-subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription + + +## complete-trigger-invocation +Complete Trigger Invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the invocation to complete. + Body | complete_invocation | [**CompleteInvocation**](../models/complete-invocation) | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.complete_invocation import CompleteInvocation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + 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() + new_complete_invocation.from_json(complete_invocation) + TriggersApi(api_client).complete_trigger_invocation(id, new_complete_invocation) + # Below is a request that includes all optional parameters + # TriggersApi(api_client).complete_trigger_invocation(id, new_complete_invocation) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-subscription +Create a Subscription +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 + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | subscription_post_request | [**SubscriptionPostRequest**](../models/subscription-post-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. | Subscription | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.subscription import Subscription +from sailpoint.beta.models.subscription_post_request import SubscriptionPostRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_subscription_post_request.from_json(subscription_post_request) + results =TriggersApi(api_client).create_subscription(new_subscription_post_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).create_subscription(new_subscription_post_request) + print("The response of TriggersApi->create_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-subscription +Delete a Subscription +Deletes an existing subscription to a trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Subscription ID + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + + try: + # Delete a Subscription + + TriggersApi(api_client).delete_subscription(id) + # Below is a request that includes all optional parameters + # TriggersApi(api_client).delete_subscription(id) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-subscriptions +List Subscriptions +Gets a list of all trigger subscriptions. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions) + +### 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* **triggerId**: *eq* **type**: *eq, le* + 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: **triggerId, triggerName** + +### Return type +[**List[Subscription]**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of subscriptions. | List[Subscription] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.subscription import Subscription +from pprint import pprint +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 \"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() + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-trigger-invocation-status +List Latest Invocation Statuses +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-trigger-invocation-status) + +### 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** + +### Return type +[**List[InvocationStatus]**](../models/invocation-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of latest invocation statuses. | List[InvocationStatus] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.invocation_status import InvocationStatus +from pprint import pprint +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 = '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() + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-triggers +List Triggers +Gets a list of triggers that are available in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers) + +### 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, ge, le* + 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** + +### Return type +[**List[Trigger]**](../models/trigger) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of triggers. | List[Trigger] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.trigger import Trigger +from pprint import pprint +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 \"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() + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-subscription +Patch a Subscription +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** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Subscription to patch + Body | subscription_patch_request_inner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated subscription. | Subscription | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.subscription import Subscription +from sailpoint.beta.models.subscription_patch_request_inner import SubscriptionPatchRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 + [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + + try: + # Patch a Subscription + new_subscription_patch_request_inner = SubscriptionPatchRequestInner() + new_subscription_patch_request_inner.from_json(subscription_patch_request_inner) + results =TriggersApi(api_client).patch_subscription(id, new_subscription_patch_request_inner) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).patch_subscription(id, new_subscription_patch_request_inner) + print("The response of TriggersApi->patch_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-test-trigger-invocation +Start a Test Invocation +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-test-trigger-invocation) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | test_invocation | [**TestInvocation**](../models/test-invocation) | True | + +### Return type +[**List[Invocation]**](../models/invocation) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Test trigger invocations that have been started for specified subscription(s). | List[Invocation] | - | +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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.invocation import Invocation +from sailpoint.beta.models.test_invocation import TestInvocation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_test_invocation.from_json(test_invocation) + results =TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-subscription-filter +Validate a Subscription Filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-subscription-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | validate_filter_input_dto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True | + +### Return type +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Boolean whether specified filter expression is valid against the input. | ValidateFilterOutputDto | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.validate_filter_input_dto import ValidateFilterInputDto +from sailpoint.beta.models.validate_filter_output_dto import ValidateFilterOutputDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + validate_filter_input_dto = { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } # ValidateFilterInputDto | + + try: + # Validate a Subscription Filter + new_validate_filter_input_dto = ValidateFilterInputDto() + new_validate_filter_input_dto.from_json(validate_filter_input_dto) + results =TriggersApi(api_client).test_subscription_filter(new_validate_filter_input_dto) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).test_subscription_filter(new_validate_filter_input_dto) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-subscription +Update a Subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Subscription ID + Body | subscription_put_request | [**SubscriptionPutRequest**](../models/subscription-put-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated subscription. | Subscription | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.subscription import Subscription +from sailpoint.beta.models.subscription_put_request import SubscriptionPutRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + 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() + new_subscription_put_request.from_json(subscription_put_request) + results =TriggersApi(api_client).update_subscription(id, new_subscription_put_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).update_subscription(id, new_subscription_put_request) + print("The response of TriggersApi->update_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md new file mode 100644 index 000000000..a8d3adba2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md @@ -0,0 +1,148 @@ +--- +id: beta-ui-metadata +title: UI_Metadata +pagination_label: UI_Metadata +sidebar_label: UI_Metadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UI_Metadata', 'BetaUI_Metadata'] +slug: /tools/sdk/python/beta/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UI_Metadata', 'BetaUI_Metadata'] +--- + +# sailpoint.beta.UIMetadataApi + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata + + +## get-tenant-ui-metadata +Get a tenant UI metadata +This API endpoint retrieves UI metadata configured for your tenant. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-ui-metadata) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A tenant UI metadata object | TenantUiMetadataItemResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.ui_metadata_api import UIMetadataApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get a tenant UI metadata + + results =UIMetadataApi(api_client).get_tenant_ui_metadata() + # Below is a request that includes all optional parameters + # results = UIMetadataApi(api_client).get_tenant_ui_metadata() + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(results) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-tenant-ui-metadata +Update tenant UI metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tenant-ui-metadata) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | tenant_ui_metadata_item_update_request | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True | + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A tenant UI metadata object | TenantUiMetadataItemResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.ui_metadata_api import UIMetadataApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse +from sailpoint.beta.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + results =UIMetadataApi(api_client).set_tenant_ui_metadata(new_tenant_ui_metadata_item_update_request) + # Below is a request that includes all optional parameters + # results = UIMetadataApi(api_client).set_tenant_ui_metadata(new_tenant_ui_metadata_item_update_request) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(results) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md new file mode 100644 index 000000000..429c3d9f3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md @@ -0,0 +1,254 @@ +--- +id: beta-vendor-connector-mappings +title: Vendor_Connector_Mappings +pagination_label: Vendor_Connector_Mappings +sidebar_label: Vendor_Connector_Mappings +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Vendor_Connector_Mappings', 'BetaVendor_Connector_Mappings'] +slug: /tools/sdk/python/beta/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'Vendor_Connector_Mappings', 'BetaVendor_Connector_Mappings'] +--- + +# sailpoint.beta.VendorConnectorMappingsApi + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-vendor-connector-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | vendor_connector_mapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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() + new_vendor_connector_mapping.from_json(vendor_connector_mapping) + results =VendorConnectorMappingsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-vendor-connector-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | vendor_connector_mapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response +from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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() + new_vendor_connector_mapping.from_json(vendor_connector_mapping) + results =VendorConnectorMappingsApi(api_client).delete_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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-vendor-connector-mappings) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[VendorConnectorMapping]**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully retrieved list. | List[VendorConnectorMapping] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md new file mode 100644 index 000000000..a0d963810 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md @@ -0,0 +1,817 @@ +--- +id: beta-work-items +title: Work_Items +pagination_label: Work_Items +sidebar_label: Work_Items +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Work_Items', 'BetaWork_Items'] +slug: /tools/sdk/python/beta/methods/work-items +tags: ['SDK', 'Software Development Kit', 'Work_Items', 'BetaWork_Items'] +--- + +# sailpoint.beta.WorkItemsApi + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item +[**forward-work-item**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **GET** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + + +## approve-approval-item +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item +Path | approval_item_id | **str** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## approve-approval-items-in-bulk +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-items-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## complete-work-item +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A WorkItems object | WorkItems | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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: + # Complete a Work Item + + results =WorkItemsApi(api_client).complete_work_item(id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## forward-work-item +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Success, but no data is returned. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_item_forward import WorkItemForward +from pprint import pprint +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 + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward() + new_work_item_forward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-completed-work-items +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-completed-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + 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[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of completed work items. | List[WorkItems] | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + owner_id = 'owner_id_example' # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-count-completed-work-items +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-completed-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**List[WorkItemsCount]**](../models/work-items-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | List[WorkItemsCount] | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items_count import WorkItemsCount +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-count-work-items +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsCount | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items_count import WorkItemsCount +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + owner_id = 'owner_id_example' # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-work-item +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the work item. + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**List[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The work item with the given ID. | List[WorkItems] | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | ID of the work item. # str | ID of the work item. + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + + try: + # Get a Work Item + + results =WorkItemsApi(api_client).get_work_item(id, ) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id, owner_id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-work-items-summary +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-items-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsSummary**](../models/work-items-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsSummary | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items_summary import WorkItemsSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + owner_id = 'owner_id_example' # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-work-items +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-work-items) + +### 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 | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**List[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | List[WorkItems] | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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 = 'owner_id_example' # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-approval-item +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item +Path | approval_item_id | **str** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-approval-items-in-bulk +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-items-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-account-selection +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-account-selection) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + Body | request_body | **map[string]object** | True | Account Selection Data map, keyed on fieldName + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +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 +import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.work_items import WorkItems +from pprint import pprint +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() + new_request_body.from_json(request_body) + results =WorkItemsApi(api_client).submit_account_selection(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md new file mode 100644 index 000000000..bdd1ce975 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md @@ -0,0 +1,599 @@ +--- +id: beta-work-reassignment +title: Work_Reassignment +pagination_label: Work_Reassignment +sidebar_label: Work_Reassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Work_Reassignment', 'BetaWork_Reassignment'] +slug: /tools/sdk/python/beta/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'Work_Reassignment', 'BetaWork_Reassignment'] +--- + +# sailpoint.beta.WorkReassignmentApi + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-reassignment-configuration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations +[**put-reassignment-config**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + + +## create-reassignment-configuration +Create a Reassignment Configuration +Creates a new Reassignment Configuration for the specified identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | configuration_item_request | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The newly created Reassignment Configuration object | ConfigurationItemResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest +from sailpoint.beta.models.configuration_item_response import ConfigurationItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + 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() + new_configuration_item_request.from_json(configuration_item_request) + results =WorkReassignmentApi(api_client).create_reassignment_configuration(new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).create_reassignment_configuration(new_configuration_item_request) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-reassignment-configuration +Delete Reassignment Configuration +Deletes a single reassignment configuration for the specified identity + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id +Path | config_type | [**ConfigTypeEnum**](../models/config-type-enum) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Reassignment Configuration deleted | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.config_type_enum import ConfigTypeEnum +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + + try: + # Delete Reassignment Configuration + + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type) + # Below is a request that includes all optional parameters + # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-evaluate-reassignment-configuration +Evaluate Reassignment Configuration +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-evaluate-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id +Path | config_type | [**ConfigTypeEnum**](../models/config-type-enum) | True | Reassignment work type + Query | exclusion_filters | **[]str** | (optional) | 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 + +### Return type +[**List[EvaluateResponse]**](../models/evaluate-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Evaluated Reassignment Configuration | List[EvaluateResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.config_type_enum import ConfigTypeEnum +from sailpoint.beta.models.evaluate_response import EvaluateResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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) + + 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, config_type, ) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-reassignment-config-types +List Reassignment Config Types +Gets a collection of types which are available in the Reassignment Configuration UI. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-config-types) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[ConfigType]**](../models/config-type) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Reassignment Configuration Types | List[ConfigType] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.config_type import ConfigType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Reassignment Config Types + + results =WorkReassignmentApi(api_client).get_reassignment_config_types() + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_config_types() + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-reassignment-configuration +Get Reassignment Configuration +Gets the Reassignment Configuration for an identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id + +### Return type +[**ConfigurationResponse**](../models/configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reassignment Configuration for an identity | ConfigurationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.configuration_response import ConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + + try: + # Get Reassignment Configuration + + results =WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-tenant-config-configuration +Get Tenant-wide Reassignment Configuration settings +Gets the global Reassignment Configuration settings for the requestor's tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-config-configuration) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tenant_configuration_response import TenantConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get Tenant-wide Reassignment Configuration settings + + results =WorkReassignmentApi(api_client).get_tenant_config_configuration() + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration() + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-reassignment-configurations +List Reassignment Configurations +Gets all Reassignment configuration for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 20) | Max number of results to return. + Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + +### Return type +[**List[ConfigurationResponse]**](../models/configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of Reassignment Configurations for an org | List[ConfigurationResponse] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.configuration_response import ConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) + 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) + + try: + # List Reassignment Configurations + + results =WorkReassignmentApi(api_client).list_reassignment_configurations() + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-reassignment-config +Update Reassignment Configuration +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-reassignment-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id + Body | configuration_item_request | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reassignment Configuration updated | ConfigurationItemResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest +from sailpoint.beta.models.configuration_item_response import ConfigurationItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + 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() + new_configuration_item_request.from_json(configuration_item_request) + results =WorkReassignmentApi(api_client).put_reassignment_config(identity_id, new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, new_configuration_item_request) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-tenant-configuration +Update Tenant-wide Reassignment Configuration settings +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tenant-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | tenant_configuration_request | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | True | + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.tenant_configuration_request import TenantConfigurationRequest +from sailpoint.beta.models.tenant_configuration_response import TenantConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + tenant_configuration_request = { + "configDetails" : { + "disabled" : true + } + } # TenantConfigurationRequest | + + try: + # Update Tenant-wide Reassignment Configuration settings + new_tenant_configuration_request = TenantConfigurationRequest() + new_tenant_configuration_request.from_json(tenant_configuration_request) + results =WorkReassignmentApi(api_client).put_tenant_configuration(new_tenant_configuration_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_tenant_configuration(new_tenant_configuration_request) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md new file mode 100644 index 000000000..7636b18ba --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md @@ -0,0 +1,1184 @@ +--- +id: beta-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Workflows', 'BetaWorkflows'] +slug: /tools/sdk/python/beta/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'BetaWorkflows'] +--- + +# sailpoint.beta.WorkflowsApi + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow +[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **GET** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow +[**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id +[**update-workflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-workflow-execution) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The workflow execution ID + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_workflow_request | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest +from sailpoint.beta.models.workflow import Workflow +from pprint import pprint +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() + new_create_workflow_request.from_json(create_workflow_request) + results =WorkflowsApi(api_client).create_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + +### 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The workflow object | Workflow | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow import Workflow +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Workflow execution ID. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Workflow execution. | 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. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution-history) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow execution + +### Return type +[**List[WorkflowExecutionEvent]**](../models/workflow-execution-event) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow execution events for the given workflow execution | List[WorkflowExecutionEvent] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-executions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Workflow ID. + 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* + +### Return type +[**List[WorkflowExecution]**](../models/workflow-execution) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow executions for the specified workflow. | List[WorkflowExecution] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow_execution import WorkflowExecution +from pprint import pprint +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: **startTime**: *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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + try: + # List Workflow Executions + + results =WorkflowsApi(api_client).get_workflow_executions(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-complete-workflow-library) + +### 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[ListCompleteWorkflowLibrary200ResponseInner]**](../models/list-complete-workflow-library200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow steps | List[ListCompleteWorkflowLibrary200ResponseInner] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-actions) + +### 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 | 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* + +### Return type +[**List[WorkflowLibraryAction]**](../models/workflow-library-action) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow actions | List[WorkflowLibraryAction] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-operators) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[WorkflowLibraryOperator]**](../models/workflow-library-operator) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow operators | List[WorkflowLibraryOperator] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-triggers) + +### 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 | 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* + +### Return type +[**List[WorkflowLibraryTrigger]**](../models/workflow-library-trigger) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow triggers | List[WorkflowLibraryTrigger] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[Workflow]**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflows | List[Workflow] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow import Workflow +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +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 +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation +from sailpoint.beta.models.workflow import Workflow +from pprint import pprint +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 + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =WorkflowsApi(api_client).patch_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## post-external-execute-workflow +Execute Workflow via External Trigger +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/post-external-execute-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | post_external_execute_workflow_request | [**PostExternalExecuteWorkflowRequest**](../models/post-external-execute-workflow-request) | (optional) | + +### Return type +[**PostExternalExecuteWorkflow200Response**](../models/post-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | PostExternalExecuteWorkflow200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response +from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest +from pprint import pprint +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 + post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional) + + try: + # Execute Workflow via External Trigger + + results =WorkflowsApi(api_client).post_external_execute_workflow(id, ) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## post-workflow-external-trigger +Generate External Trigger OAuth Client +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/post-workflow-external-trigger) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + +### Return type +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The OAuth Client object | WorkflowOAuthClient | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient +from pprint import pprint +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).post_workflow_external_trigger(id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-external-execute-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | test_external_execute_workflow_request | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | + +### Return type +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the test input | TestExternalExecuteWorkflow200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response +from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest +from pprint import pprint +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.beta.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + + try: + # Test Workflow via External Trigger + + results =WorkflowsApi(api_client).test_external_execute_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | test_workflow_request | [**TestWorkflowRequest**](../models/test-workflow-request) | True | + +### Return type +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | TestWorkflow200Response | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response +from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest +from pprint import pprint +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() + new_test_workflow_request.from_json(test_workflow_request) + results =WorkflowsApi(api_client).test_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +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. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow import Workflow +from sailpoint.beta.models.workflow_body import WorkflowBody +from pprint import pprint +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" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + + try: + # Update Workflow + new_workflow_body = WorkflowBody() + new_workflow_body.from_json(workflow_body) + results =WorkflowsApi(api_client).update_workflow(id, new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->update_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessConstraint.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessConstraint.md new file mode 100644 index 000000000..c191c8198 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessConstraint.md @@ -0,0 +1,37 @@ +--- +id: beta-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessConstraint', 'BetaAccessConstraint'] +slug: /tools/sdk/python/beta/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'BetaAccessConstraint'] +--- + +# AccessConstraint + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Type of Access | [required] +**ids** | **[]str** | Must be set only if operator is SELECTED. | [optional] +**operator** | **Enum** [ 'ALL', 'SELECTED' ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_constraint import AccessConstraint + +access_constraint = AccessConstraint( +type='ENTITLEMENT', +ids=[2c90ad2a70ace7d50170acf22ca90010], +operator='SELECTED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessCriteria.md new file mode 100644 index 000000000..be0cf3b4f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessCriteria.md @@ -0,0 +1,35 @@ +--- +id: beta-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteria', 'BetaAccessCriteria'] +slug: /tools/sdk/python/beta/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'BetaAccessCriteria'] +--- + +# AccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Business name for the access construct list | [optional] +**criteria_list** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_criteria import AccessCriteria + +access_criteria = AccessCriteria( +name='money-in', +criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..7d87f63c6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,37 @@ +--- +id: beta-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner'] +slug: /tools/sdk/python/beta/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | DTO type | [optional] +**id** | **str** | ID of the object to which this reference applies to | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_criteria_criteria_list_inner import AccessCriteriaCriteriaListInner + +access_criteria_criteria_list_inner = AccessCriteriaCriteriaListInner( +type='ENTITLEMENT', +id='2c91808568c529c60168cca6f90c1313', +name='Administrator' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..0142eece1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,55 @@ +--- +id: beta-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse'] +slug: /tools/sdk/python/beta/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse'] +--- + +# AccessItemAccessProfileResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. accessProfile in this case | [optional] +**id** | **str** | the access item id | [optional] +**name** | **str** | the access profile name | [optional] +**source_name** | **str** | the name of the source | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the access profile | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional] +**app_display_name** | **str** | the name of | [optional] +**remove_date** | **str** | the date the access profile is no longer assigned to the specified identity | [optional] +**standalone** | **bool** | indicates whether the access profile is standalone | [required] +**revocable** | **bool** | indicates whether the access profile is | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_item_access_profile_response import AccessItemAccessProfileResponse + +access_item_access_profile_response = AccessItemAccessProfileResponse( +access_type='accessProfile', +id='2c918087763e69d901763e72e97f006f', +name='sample', +source_name='DataScienceDataset', +source_id='2793o32dwd', +description='AccessProfile - Workday/Citizenship access', +display_name='Dr. Arden Rogahn MD', +entitlement_count='12', +app_display_name='AppName', +remove_date='2024-07-01T06:00:00.00Z', +standalone=False, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccountResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..d08190f75 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccountResponse.md @@ -0,0 +1,45 @@ +--- +id: beta-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse'] +slug: /tools/sdk/python/beta/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse'] +--- + +# AccessItemAccountResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. account in this case | [optional] +**id** | **str** | the access item id | [optional] +**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] +**source_name** | **str** | the name of the source | [optional] +**source_id** | **str** | the id of the source | [optional] +**entitlement_count** | **str** | the number of entitlements the account will create | [optional] +**display_name** | **str** | the display name of the identity | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_account_response import AccessItemAccountResponse + +access_item_account_response = AccessItemAccountResponse( +access_type='account', +id='2c918087763e69d901763e72e97f006f', +native_identity='dr.arden.ogahn.d', +source_name='DataScienceDataset', +source_id='2793o32dwd', +entitlement_count='12', +display_name='Dr. Arden Rogahn MD' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAppResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..bbc47e636 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAppResponse.md @@ -0,0 +1,41 @@ +--- +id: beta-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAppResponse', 'BetaAccessItemAppResponse'] +slug: /tools/sdk/python/beta/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessItemAppResponse'] +--- + +# AccessItemAppResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. entitlement in this case | [optional] +**id** | **str** | the access item id | [optional] +**display_name** | **str** | the access item display name | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**app_role_id** | **str** | the app role id | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_app_response import AccessItemAppResponse + +access_item_app_response = AccessItemAppResponse( +access_type='app', +id='2c918087763e69d901763e72e97f006f', +display_name='Display Name', +source_name='appName', +app_role_id='2c918087763e69d901763e72e97f006f' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemApproverDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..77ab124c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemApproverDto.md @@ -0,0 +1,38 @@ +--- +id: beta-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemApproverDto', 'BetaAccessItemApproverDto'] +slug: /tools/sdk/python/beta/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessItemApproverDto'] +--- + +# AccessItemApproverDto + +Identity who approved the access item request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who approved the access item request. | [optional] +**id** | **str** | ID of identity who approved the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who approved the access item request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_approver_dto import AccessItemApproverDto + +access_item_approver_dto = AccessItemApproverDto( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociated.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociated.md new file mode 100644 index 000000000..32ca64e48 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociated.md @@ -0,0 +1,50 @@ +--- +id: beta-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAssociated', 'BetaAccessItemAssociated'] +slug: /tools/sdk/python/beta/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessItemAssociated'] +--- + +# AccessItemAssociated + + +## 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] +} + +## Example + +```python +from sailpoint.beta.models.access_item_associated import AccessItemAssociated + +access_item_associated = AccessItemAssociated( +access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name}, +identity_id='8c190e6787aa4ed9a90bd9d5344523fb', +event_type='AccessItemAssociated', +dt='2019-03-08T22:37:33.901Z', +governance_event=sailpoint.beta.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.beta.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..7e6595253 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,69 @@ +--- +id: beta-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem'] +slug: /tools/sdk/python/beta/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem'] +--- + +# AccessItemAssociatedAccessItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. role in this case | [optional] +**id** | **str** | the access item id | [optional] +**name** | **str** | the access profile name | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the role | [optional] +**display_name** | **str** | the role display name | [optional] +**entitlement_count** | **str** | the number of entitlements the account will create | [optional] +**app_display_name** | **str** | the name of | [optional] +**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional] +**standalone** | **bool** | indicates whether the entitlement is standalone | [required] +**revocable** | **bool** | indicates whether the role is revocable | [required] +**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] +**app_role_id** | **str** | the app role id | [optional] +**attribute** | **str** | the entitlement attribute | [optional] +**value** | **str** | the associated value | [optional] +**entitlement_type** | **str** | the type of entitlement | [optional] +**privileged** | **bool** | indicates whether the entitlement is privileged | [required] +**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_item_associated_access_item import AccessItemAssociatedAccessItem + +access_item_associated_access_item = AccessItemAssociatedAccessItem( +access_type='role', +id='2c918087763e69d901763e72e97f006f', +name='sample', +source_name='Source Name', +source_id='2793o32dwd', +description='Role - Workday/Citizenship access', +display_name='sample', +entitlement_count='12', +app_display_name='AppName', +remove_date='2024-07-01T06:00:00.00Z', +standalone=True, +revocable=True, +native_identity='dr.arden.ogahn.d', +app_role_id='2c918087763e69d901763e72e97f006f', +attribute='groups', +value='Upward mobility access', +entitlement_type='entitlement', +privileged=False, +cloud_governed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemDiff.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemDiff.md new file mode 100644 index 000000000..47aa05ed9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemDiff.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemDiff', 'BetaAccessItemDiff'] +slug: /tools/sdk/python/beta/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'BetaAccessItemDiff'] +--- + +# AccessItemDiff + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of the access item | [optional] +**event_type** | **Enum** [ 'ADD', 'REMOVE' ] | | [optional] +**display_name** | **str** | the display name of the access item | [optional] +**source_name** | **str** | the source name of the access item | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_diff import AccessItemDiff + +access_item_diff = AccessItemDiff( +id='', +event_type='ADD', +display_name='', +source_name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..7d09eeafe --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,55 @@ +--- +id: beta-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse'] +slug: /tools/sdk/python/beta/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse'] +--- + +# AccessItemEntitlementResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. entitlement in this case | [optional] +**id** | **str** | the access item id | [optional] +**attribute** | **str** | the entitlement attribute | [optional] +**value** | **str** | the associated value | [optional] +**entitlement_type** | **str** | the type of entitlement | [optional] +**source_name** | **str** | the name of the source | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the entitlment | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**standalone** | **bool** | indicates whether the entitlement is standalone | [required] +**privileged** | **bool** | indicates whether the entitlement is privileged | [required] +**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_item_entitlement_response import AccessItemEntitlementResponse + +access_item_entitlement_response = AccessItemEntitlementResponse( +access_type='entitlement', +id='2c918087763e69d901763e72e97f006f', +attribute='groups', +value='Upward mobility access', +entitlement_type='entitlement', +source_name='DataScienceDataset', +source_id='2793o32dwd', +description='Entitlement - Workday/Citizenship access', +display_name='Dr. Arden Rogahn MD', +standalone=True, +privileged=False, +cloud_governed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemOwnerDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemOwnerDto.md new file mode 100644 index 000000000..a6f7ecc58 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemOwnerDto.md @@ -0,0 +1,38 @@ +--- +id: beta-access-item-owner-dto +title: AccessItemOwnerDto +pagination_label: AccessItemOwnerDto +sidebar_label: AccessItemOwnerDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto'] +slug: /tools/sdk/python/beta/models/access-item-owner-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto'] +--- + +# AccessItemOwnerDto + +Access item owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item owner's DTO type. | [optional] +**id** | **str** | Access item owner's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_owner_dto import AccessItemOwnerDto + +access_item_owner_dto = AccessItemOwnerDto( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRef.md new file mode 100644 index 000000000..d67824e1c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRef.md @@ -0,0 +1,35 @@ +--- +id: beta-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRef', 'BetaAccessItemRef'] +slug: /tools/sdk/python/beta/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'BetaAccessItemRef'] +--- + +# AccessItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the access item to retrieve the recommendation for. | [optional] +**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Access item's type. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_ref import AccessItemRef + +access_item_ref = AccessItemRef( +id='2c938083633d259901633d2623ec0375', +type='ENTITLEMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRemoved.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRemoved.md new file mode 100644 index 000000000..30cc5bffb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRemoved.md @@ -0,0 +1,50 @@ +--- +id: beta-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRemoved', 'BetaAccessItemRemoved'] +slug: /tools/sdk/python/beta/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRemoved'] +--- + +# AccessItemRemoved + + +## 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] +} + +## Example + +```python +from sailpoint.beta.models.access_item_removed import AccessItemRemoved + +access_item_removed = AccessItemRemoved( +access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name}, +identity_id='8c190e6787aa4ed9a90bd9d5344523fb', +event_type='AccessItemRemoved', +dt='2019-03-08T22:37:33.901Z', +governance_event=sailpoint.beta.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.beta.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..4c76f0c34 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequestedForDto.md @@ -0,0 +1,38 @@ +--- +id: beta-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto'] +slug: /tools/sdk/python/beta/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto'] +--- + +# AccessItemRequestedForDto + +Identity the access item is requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity the access item is requested for. | [optional] +**id** | **str** | ID of identity the access item is requested for. | [optional] +**name** | **str** | Human-readable display name of identity the access item is requested for. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_requested_for_dto import AccessItemRequestedForDto + +access_item_requested_for_dto = AccessItemRequestedForDto( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequester.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequester.md new file mode 100644 index 000000000..df9c4f8c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequester.md @@ -0,0 +1,38 @@ +--- +id: beta-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequester', 'BetaAccessItemRequester'] +slug: /tools/sdk/python/beta/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'BetaAccessItemRequester'] +--- + +# AccessItemRequester + +Access item requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional] +**id** | **str** | Access item requester's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_requester import AccessItemRequester + +access_item_requester = AccessItemRequester( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequesterDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..bffe5cd2f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequesterDto.md @@ -0,0 +1,38 @@ +--- +id: beta-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto'] +slug: /tools/sdk/python/beta/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto'] +--- + +# AccessItemRequesterDto + +Access item requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional] +**id** | **str** | Access item requester's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_requester_dto import AccessItemRequesterDto + +access_item_requester_dto = AccessItemRequesterDto( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemReviewedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..c0c7ef65d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemReviewedBy.md @@ -0,0 +1,38 @@ +--- +id: beta-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy'] +slug: /tools/sdk/python/beta/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +Identity who reviewed the access item request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_item_reviewed_by import AccessItemReviewedBy + +access_item_reviewed_by = AccessItemReviewedBy( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRoleResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..cdba54586 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessItemRoleResponse.md @@ -0,0 +1,45 @@ +--- +id: beta-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse'] +slug: /tools/sdk/python/beta/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse'] +--- + +# AccessItemRoleResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. role in this case | [optional] +**id** | **str** | the access item id | [optional] +**display_name** | **str** | the role display name | [optional] +**description** | **str** | the description for the role | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional] +**revocable** | **bool** | indicates whether the role is revocable | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_item_role_response import AccessItemRoleResponse + +access_item_role_response = AccessItemRoleResponse( +access_type='role', +id='2c918087763e69d901763e72e97f006f', +display_name='sample', +description='Role - Workday/Citizenship access', +source_name='Source Name', +remove_date='2024-07-01T06:00:00.00Z', +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md new file mode 100644 index 000000000..a99ed624b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md @@ -0,0 +1,91 @@ +--- +id: beta-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfile', 'BetaAccessProfile'] +slug: /tools/sdk/python/beta/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] +--- + +# AccessProfile + +Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Access Profile | [optional] [readonly] +**name** | **str** | Name of the Access Profile | [required] +**description** | **str** | Information about the Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] +**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**access_request_config** | [**Requestability**](requestability) | | [optional] +**revocation_request_config** | [**Revocability**](revocability) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile import AccessProfile + +access_profile = AccessProfile( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +created='2021-03-01T22:32:58.104Z', +modified='2021-03-02T20:22:28.104Z', +enabled=True, +owner=sailpoint.beta.models.owner_reference.OwnerReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +source=sailpoint.beta.models.access_profile_source_ref.AccessProfileSourceRef( + id = '2c91809773dee3610173fdb0b6061ef4', + type = 'SOURCE', + name = 'ODS-AD-SOURCE', ), +entitlements=[ + sailpoint.beta.models.entitlement_ref.EntitlementRef( + type = 'ENTITLEMENT', + id = '2c91809773dee32014e13e122092014e', + name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', ) + ], +requestable=True, +access_request_config=sailpoint.beta.models.requestability.Requestability( + comments_required = True, + denial_comments_required = True, + approval_schemes = [ + sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +revocation_request_config=sailpoint.beta.models.revocability.Revocability( + approval_schemes = [ + sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +provisioning_criteria=sailpoint.beta.models.provisioning_criteria_level1.ProvisioningCriteriaLevel1( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.beta.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2( + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..3e7d081df --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,35 @@ +--- +id: beta-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme'] +slug: /tools/sdk/python/beta/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **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.beta.models.access_profile_approval_scheme import AccessProfileApprovalScheme + +access_profile_approval_scheme = AccessProfileApprovalScheme( +approver_type='GOVERNANCE_GROUP', +approver_id='46c79819-a69f-49a2-becb-12c971ae66c6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..fcbbb3cef --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest'] +slug: /tools/sdk/python/beta/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_profile_ids** | **[]str** | List of IDs of Access Profiles to be deleted. | [optional] +**best_effort_only** | **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest + +access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest( +access_profile_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816], +best_effort_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..d2cdf8a7d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,46 @@ +--- +id: beta-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse'] +slug: /tools/sdk/python/beta/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_id** | **str** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional] +**pending** | **[]str** | List of IDs of Access Profiles which are pending deletion. | [optional] +**in_use** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse + +access_profile_bulk_delete_response = AccessProfileBulkDeleteResponse( +task_id='2c9180867817ac4d017817c491119a20', +pending=[2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816], +in_use=[ + sailpoint.beta.models.access_profile_usage.AccessProfileUsage( + access_profile_id = '2c91808876438bbb017668c21919ecca', + used_by = [ + sailpoint.beta.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner( + type = 'ROLE', + id = '2c8180857a9b3da0017aa03418480f9d', + name = 'Manager Role', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..d3c5ac5fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,36 @@ +--- +id: beta-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/python/beta/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner'] +--- + +# AccessProfileBulkUpdateRequestInner + +Access Profile's basic details. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Access Profile ID. | [optional] +**requestable** | **bool** | Access Profile is requestable or not. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner + +access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner( +id='464ae7bf-791e-49fd-b746-06a2e4a8', +requestable=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetails.md new file mode 100644 index 000000000..bb504f7f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetails.md @@ -0,0 +1,85 @@ +--- +id: beta-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDetails', 'BetaAccessProfileDetails'] +slug: /tools/sdk/python/beta/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'BetaAccessProfileDetails'] +--- + +# AccessProfileDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Access Profile | [optional] +**name** | **str** | Name of the Access Profile | [optional] +**description** | **str** | Information about the Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created | [optional] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] +**disabled** | **bool** | Whether the Access Profile is enabled. | [optional] [default to True] +**requestable** | **bool** | Whether the Access Profile is requestable via access request. | [optional] [default to False] +**protected** | **bool** | Whether the Access Profile is protected. | [optional] [default to False] +**owner_id** | **str** | The owner ID of the Access Profile | [optional] +**source_id** | **int** | The source ID of the Access Profile | [optional] +**source_name** | **str** | The source name of the Access Profile | [optional] +**app_id** | **int** | The source app ID of the Access Profile | [optional] +**app_name** | **str** | The source app name of the Access Profile | [optional] +**application_id** | **str** | The id of the application | [optional] +**type** | **str** | The type of the access profile | [optional] +**entitlements** | **[]str** | List of IDs of entitlements | [optional] +**entitlement_count** | **int** | The number of entitlements in the access profile | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**approval_schemes** | **str** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**revoke_request_approval_schemes** | **str** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**request_comments_required** | **bool** | Whether the access profile require request comment for access request. | [optional] [default to False] +**denied_comments_required** | **bool** | Whether denied comment is required when access request is denied. | [optional] [default to False] +**account_selector** | [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_details import AccessProfileDetails + +access_profile_details = AccessProfileDetails( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +created='2021-03-01T22:32:58.104Z', +modified='2021-03-02T20:22:28.104Z', +disabled=True, +requestable=True, +protected=False, +owner_id='9870808a7190d06e01719938fcd20792', +source_id=10360661, +source_name='AD Source', +app_id=10360661, +app_name='mail app', +application_id='edcb0951812949d085b60cd8bf35bc78', +type='source', +entitlements=[2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9], +entitlement_count=12, +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +approval_schemes='accessProfileOwner', +revoke_request_approval_schemes='accessProfileOwner', +request_comments_required=True, +denied_comments_required=True, +account_selector=sailpoint.beta.models.access_profile_details_account_selector.AccessProfileDetails_accountSelector( + selectors = [ + sailpoint.beta.models.selector.selector( + application_id = '2c91808874ff91550175097daaec161c"', + account_match_config = sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ), ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..c9f5b9397 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,41 @@ +--- +id: beta-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector'] +slug: /tools/sdk/python/beta/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector'] +--- + +# AccessProfileDetailsAccountSelector + +How to select account when there are multiple accounts for the user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selectors** | [**[]Selector**](selector) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_details_account_selector import AccessProfileDetailsAccountSelector + +access_profile_details_account_selector = AccessProfileDetailsAccountSelector( +selectors=[ + sailpoint.beta.models.selector.selector( + application_id = '2c91808874ff91550175097daaec161c"', + account_match_config = sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileRef.md new file mode 100644 index 000000000..d92058f25 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileRef.md @@ -0,0 +1,37 @@ +--- +id: beta-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileRef', 'BetaAccessProfileRef'] +slug: /tools/sdk/python/beta/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'BetaAccessProfileRef'] +--- + +# AccessProfileRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the Access Profile | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE' ] | 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. | [optional] +**name** | **str** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_ref import AccessProfileRef + +access_profile_ref = AccessProfileRef( +id='ff808081751e6e129f1518161919ecca', +type='ACCESS_PROFILE', +name='Access Profile 2567' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..02afdf188 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md @@ -0,0 +1,37 @@ +--- +id: beta-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef'] +slug: /tools/sdk/python/beta/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] +**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] +**name** | **str** | The display name of the associated Source | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_source_ref import AccessProfileSourceRef + +access_profile_source_ref = AccessProfileSourceRef( +id='2c91809773dee3610173fdb0b6061ef4', +type='SOURCE', +name='ODS-AD-SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..8ea4a7b00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUpdateItem.md @@ -0,0 +1,43 @@ +--- +id: beta-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem'] +slug: /tools/sdk/python/beta/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem'] +--- + +# AccessProfileUpdateItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of Access Profile in bulk update request. | [required] +**requestable** | **bool** | Access Profile requestable or not. | [required] +**status** | **str** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_update_item import AccessProfileUpdateItem + +access_profile_update_item = AccessProfileUpdateItem( +id='2c7180a46faadee4016fb4e018c20642', +requestable=False, +status='201', +description=' +> Access profile is updated successfully. + +> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsage.md new file mode 100644 index 000000000..16dd23048 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsage.md @@ -0,0 +1,40 @@ +--- +id: beta-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUsage', 'BetaAccessProfileUsage'] +slug: /tools/sdk/python/beta/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'BetaAccessProfileUsage'] +--- + +# AccessProfileUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_profile_id** | **str** | ID of the Access Profile that is in use | [optional] +**used_by** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_usage import AccessProfileUsage + +access_profile_usage = AccessProfileUsage( +access_profile_id='2c91808876438bbb017668c21919ecca', +used_by=[ + sailpoint.beta.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner( + type = 'ROLE', + id = '2c8180857a9b3da0017aa03418480f9d', + name = 'Manager Role', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..d47037539 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,38 @@ +--- +id: beta-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner'] +slug: /tools/sdk/python/beta/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +Role using the access profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ROLE' ] | DTO type of role using the access profile. | [optional] +**id** | **str** | ID of role using the access profile. | [optional] +**name** | **str** | Display name of role using the access profile. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_profile_usage_used_by_inner import AccessProfileUsageUsedByInner + +access_profile_usage_used_by_inner = AccessProfileUsageUsedByInner( +type='ROLE', +id='2c8180857a9b3da0017aa03418480f9d', +name='Manager Role' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRecommendationMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..2f68b888a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRecommendationMessage.md @@ -0,0 +1,33 @@ +--- +id: beta-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage'] +slug: /tools/sdk/python/beta/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage'] +--- + +# AccessRecommendationMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**interpretation** | **str** | Information about why the access item was recommended. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_recommendation_message import AccessRecommendationMessage + +access_recommendation_message = AccessRecommendationMessage( +interpretation='95% of your peers have this access.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md new file mode 100644 index 000000000..864932ac7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md @@ -0,0 +1,48 @@ +--- +id: beta-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequest', 'BetaAccessRequest'] +slug: /tools/sdk/python/beta/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'BetaAccessRequest'] +--- + +# AccessRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request import AccessRequest + +access_request = AccessRequest( +requested_for=[ + '2c918084660f45d6016617daa9210584' + ], +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.beta.models.access_request_item.AccessRequestItem( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestConfig.md new file mode 100644 index 000000000..69909e67d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestConfig.md @@ -0,0 +1,57 @@ +--- +id: beta-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestConfig', 'BetaAccessRequestConfig'] +slug: /tools/sdk/python/beta/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'BetaAccessRequestConfig'] +--- + +# AccessRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvals_must_be_external** | **bool** | 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. | [optional] [default to False] +**auto_approval_enabled** | **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to False] +**reauthorization_enabled** | **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to False] +**request_on_behalf_of_config** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**approval_reminder_and_escalation_config** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**entitlement_request_config** | [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_config import AccessRequestConfig + +access_request_config = AccessRequestConfig( +approvals_must_be_external=True, +auto_approval_enabled=True, +reauthorization_enabled=True, +request_on_behalf_of_config=sailpoint.beta.models.request_on_behalf_of_config.RequestOnBehalfOfConfig( + allow_request_on_behalf_of_anyone_by_anyone = True, + allow_request_on_behalf_of_employee_by_manager = True, ), +approval_reminder_and_escalation_config=sailpoint.beta.models.approval_reminder_and_escalation_config.ApprovalReminderAndEscalationConfig( + days_until_escalation = 0, + days_between_reminders = 0, + max_reminders = 1, + fallback_approver_ref = sailpoint.beta.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), ), +entitlement_request_config=sailpoint.beta.models.entitlement_request_config_1.EntitlementRequestConfig_1( + 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/Beta/Models/AccessRequestContext.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestContext.md new file mode 100644 index 000000000..a1ae35956 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestContext.md @@ -0,0 +1,38 @@ +--- +id: beta-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestContext', 'BetaAccessRequestContext'] +slug: /tools/sdk/python/beta/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'BetaAccessRequestContext'] +--- + +# AccessRequestContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context_attributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_context import AccessRequestContext + +access_request_context = AccessRequestContext( +context_attributes=[ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..aafc2df16 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,55 @@ +--- +id: beta-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover'] +slug: /tools/sdk/python/beta/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover'] +--- + +# AccessRequestDynamicApprover + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | 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. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_dynamic_approver import AccessRequestDynamicApprover + +access_request_dynamic_approver = AccessRequestDynamicApprover( +access_request_id='4b4d982dddff4267ab12f0f1e72b5a6d', +requested_for=[ + sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items=[ + sailpoint.beta.models.access_request_dynamic_approver_requested_items_inner.AccessRequestDynamicApprover_requestedItems_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Engineering Access', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access for his day to day job activities.', ) + ], +requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..1b195de36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1'] +slug: /tools/sdk/python/beta/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1'] +--- + +# AccessRequestDynamicApprover1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity to add to the approver list for the access request. | [required] +**name** | **str** | The name of the identity to add to the approver list for the access request. | [required] +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The type of object being referenced. | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_dynamic_approver1 import AccessRequestDynamicApprover1 + +access_request_dynamic_approver1 = AccessRequestDynamicApprover1( +id='2c91808b6ef1d43e016efba0ce470906', +name='Adam Adams', +type=IDENTITY +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..c8c7875ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,43 @@ +--- +id: beta-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/python/beta/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner'] +--- + +# AccessRequestDynamicApproverRequestedItemsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the access item. | [required] +**name** | **str** | Human friendly name of the access item. | [required] +**description** | **str** | Extended description of the access item. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item being requested. | [required] +**operation** | **Enum** [ 'Add', 'Remove' ] | Grant or revoke the access item | [required] +**comment** | **str** | A comment from the requestor on why the access is needed. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_dynamic_approver_requested_items_inner import AccessRequestDynamicApproverRequestedItemsInner + +access_request_dynamic_approver_requested_items_inner = AccessRequestDynamicApproverRequestedItemsInner( +id='2c91808b6ef1d43e016efba0ce470904', +name='Engineering Access', +description='Engineering Access', +type=ACCESS_PROFILE, +operation=Add, +comment='William needs this access for his day to day job activities.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md new file mode 100644 index 000000000..70bc09731 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItem', 'BetaAccessRequestItem'] +slug: /tools/sdk/python/beta/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'BetaAccessRequestItem'] +--- + +# AccessRequestItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | 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. | [optional] +**remove_date** | **datetime** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_item import AccessRequestItem + +access_request_item = AccessRequestItem( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItemResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..232839271 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItemResponse.md @@ -0,0 +1,47 @@ +--- +id: beta-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse'] +slug: /tools/sdk/python/beta/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse'] +--- + +# AccessRequestItemResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **str** | the access request item operation | [optional] +**access_item_type** | **str** | the access item type | [optional] +**name** | **str** | the name of access request item | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | the final decision for the access request | [optional] +**description** | **str** | the description of access request item | [optional] +**source_id** | **str** | the source id | [optional] +**source_name** | **str** | the source Name | [optional] +**approval_infos** | [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_item_response import AccessRequestItemResponse + +access_request_item_response = AccessRequestItemResponse( +operation='Add', +access_item_type='role', +name='Role-1', +decision='APPROVED', +description='The role descrition', +source_id='8a80828f643d484f01643e14202e206f', +source_name='Source1', +approval_infos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPhases.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPhases.md new file mode 100644 index 000000000..1065a2b0c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPhases.md @@ -0,0 +1,44 @@ +--- +id: beta-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPhases', 'BetaAccessRequestPhases'] +slug: /tools/sdk/python/beta/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'BetaAccessRequestPhases'] +--- + +# AccessRequestPhases + +Provides additional details about this access request phase. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**started** | **datetime** | The time that this phase started. | [optional] +**finished** | **datetime** | The time that this phase finished. | [optional] +**name** | **str** | The name of this phase. | [optional] +**state** | **Enum** [ 'PENDING', 'EXECUTING', 'COMPLETED', 'CANCELLED', 'NOT_EXECUTED' ] | The state of this phase. | [optional] +**result** | **Enum** [ 'SUCCESSFUL', 'FAILED' ] | The state of this phase. | [optional] +**phase_reference** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_phases import AccessRequestPhases + +access_request_phases = AccessRequestPhases( +started='2020-07-11T00:00Z', +finished='2020-07-12T00:00Z', +name='APPROVAL_PHASE', +state='COMPLETED', +result='SUCCESSFUL', +phase_reference='approvalDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApproval.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..d2e7244cb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApproval.md @@ -0,0 +1,64 @@ +--- +id: beta-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval'] +slug: /tools/sdk/python/beta/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval'] +--- + +# AccessRequestPostApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | The unique ID of the access request. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_post_approval import AccessRequestPostApproval + +access_request_post_approval = AccessRequestPostApproval( +access_request_id='2c91808b6ef1d43e016efba0ce470904', +requested_for=[ + sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items_status=[ + sailpoint.beta.models.access_request_post_approval_requested_items_status_inner.AccessRequestPostApproval_requestedItemsStatus_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', + client_metadata = {applicationName=My application}, + approval_info = [ + sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner( + approval_comment = 'This access looks good. Approved.', + approval_decision = APPROVED, + approver_name = 'Stephen.Austin', + approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ), ) + ], ) + ], +requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..8b7f966f6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,54 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the access item being requested. | [required] +**name** | **str** | The human friendly name of the access item. | [required] +**description** | **str** | Detailed description of the access item. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required] +**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required] +**comment** | **str** | A comment from the identity requesting the access. | [optional] +**client_metadata** | **map[string]object** | Additional customer defined metadata about the access item. | [optional] +**approval_info** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner import AccessRequestPostApprovalRequestedItemsStatusInner + +access_request_post_approval_requested_items_status_inner = AccessRequestPostApprovalRequestedItemsStatusInner( +id='2c91808b6ef1d43e016efba0ce470904', +name='Engineering Access', +description='Access to engineering database', +type=ACCESS_PROFILE, +operation=Add, +comment='William needs this access to do his job.', +client_metadata={applicationName=My application}, +approval_info=[ + sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner( + approval_comment = 'This access looks good. Approved.', + approval_decision = APPROVED, + approver_name = 'Stephen.Austin', + approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..eb3a720da --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,40 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_comment** | **str** | A comment left by the approver. | [optional] +**approval_decision** | **Enum** [ 'APPROVED', 'DENIED' ] | The final decision of the approver. | [required] +**approver_name** | **str** | The name of the approver | [required] +**approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +access_request_post_approval_requested_items_status_inner_approval_info_inner = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner( +approval_comment='This access looks good. Approved.', +approval_decision=APPROVED, +approver_name='Stephen.Austin', +approver=sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 000000000..01c8a9b67 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,38 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +The identity of the approver. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [required] +**id** | **str** | ID of identity who approved the access item request. | [required] +**name** | **str** | Human-readable display name of identity who approved the access item request. | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +access_request_post_approval_requested_items_status_inner_approval_info_inner_approver = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover( +type=IDENTITY, +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..f3b71c953 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval.md @@ -0,0 +1,55 @@ +--- +id: beta-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval'] +slug: /tools/sdk/python/beta/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval'] +--- + +# AccessRequestPreApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | The unique ID of the access request. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_pre_approval import AccessRequestPreApproval + +access_request_pre_approval = AccessRequestPreApproval( +access_request_id='2c91808b6ef1d43e016efba0ce470904', +requested_for=[ + sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items=[ + sailpoint.beta.models.access_request_pre_approval_requested_items_inner.AccessRequestPreApproval_requestedItems_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', ) + ], +requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..09069721b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval1.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1'] +slug: /tools/sdk/python/beta/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1'] +--- + +# AccessRequestPreApproval1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **bool** | Whether or not to approve the access request. | [required] +**comment** | **str** | A comment about the decision to approve or deny the request. | [required] +**approver** | **str** | The name of the entity that approved or denied the request. | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_pre_approval1 import AccessRequestPreApproval1 + +access_request_pre_approval1 = AccessRequestPreApproval1( +approved=False, +comment='This access should be denied, because this will cause an SOD violation.', +approver='AcmeCorpExternalIntegration' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..08dfe0001 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,43 @@ +--- +id: beta-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/python/beta/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner'] +--- + +# AccessRequestPreApprovalRequestedItemsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the access item being requested. | [required] +**name** | **str** | The human friendly name of the access item. | [required] +**description** | **str** | Detailed description of the access item. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required] +**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required] +**comment** | **str** | A comment from the identity requesting the access. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_pre_approval_requested_items_inner import AccessRequestPreApprovalRequestedItemsInner + +access_request_pre_approval_requested_items_inner = AccessRequestPreApprovalRequestedItemsInner( +id='2c91808b6ef1d43e016efba0ce470904', +name='Engineering Access', +description='Access to engineering database', +type=ACCESS_PROFILE, +operation=Add, +comment='William needs this access to do his job.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..ec1d95b5e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/python/beta/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto'] +--- + +# AccessRequestRecommendationActionItemDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID taking the action. | [required] +**access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto + +access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto( +identity_id='2c91808570313110017040b06f344ec9', +access=sailpoint.beta.models.access_request_recommendation_item.AccessRequestRecommendationItem( + id = '2c9180835d2e5168015d32f890ca1581', + type = 'ACCESS_PROFILE', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..438ed417b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/python/beta/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto'] +--- + +# AccessRequestRecommendationActionItemResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID taking the action. | [optional] +**access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**timestamp** | **datetime** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + +access_request_recommendation_action_item_response_dto = AccessRequestRecommendationActionItemResponseDto( +identity_id='2c91808570313110017040b06f344ec9', +access=sailpoint.beta.models.access_request_recommendation_item.AccessRequestRecommendationItem( + id = '2c9180835d2e5168015d32f890ca1581', + type = 'ACCESS_PROFILE', ), +timestamp='2017-07-11T18:45:37.098Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..901bb0b00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,35 @@ +--- +id: beta-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem'] +slug: /tools/sdk/python/beta/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem'] +--- + +# AccessRequestRecommendationItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of access item being recommended. | [optional] +**type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_recommendation_item import AccessRequestRecommendationItem + +access_request_recommendation_item = AccessRequestRecommendationItem( +id='2c9180835d2e5168015d32f890ca1581', +type='ACCESS_PROFILE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..c29ed8d6b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,52 @@ +--- +id: beta-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail'] +slug: /tools/sdk/python/beta/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail'] +--- + +# AccessRequestRecommendationItemDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity ID for the recommendation | [optional] +**access** | [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**ignored** | **bool** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**requested** | **bool** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**viewed** | **bool** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**messages** | [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**translation_messages** | [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail + +access_request_recommendation_item_detail = AccessRequestRecommendationItemDetail( +identity_id='2c91808570313110017040b06f344ec9', +access=sailpoint.beta.models.access_request_recommendation_item_detail_access.AccessRequestRecommendationItemDetail_access( + id = '2c9180835d2e5168015d32f890ca1581', + type = 'ACCESS_PROFILE', + name = 'Employee-database-read-write', + description = 'This item grants an employee read and write access to the database', ), +ignored=True, +requested=True, +viewed=True, +messages=[ + sailpoint.beta.models.access_recommendation_message.AccessRecommendationMessage( + interpretation = '95% of your peers have this access.', ) + ], +translation_messages=[{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..d22e8126a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/python/beta/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess'] +--- + +# AccessRequestRecommendationItemDetailAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of access item being recommended. | [optional] +**type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**name** | **str** | Name of the access item | [optional] +**description** | **str** | Description of the access item | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_recommendation_item_detail_access import AccessRequestRecommendationItemDetailAccess + +access_request_recommendation_item_detail_access = AccessRequestRecommendationItemDetailAccess( +id='2c9180835d2e5168015d32f890ca1581', +type='ACCESS_PROFILE', +name='Employee-database-read-write', +description='This item grants an employee read and write access to the database' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..32751d8bc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,23 @@ +--- +id: beta-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType'] +slug: /tools/sdk/python/beta/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType'] +--- + +# AccessRequestRecommendationItemType + +The type of access item. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse.md new file mode 100644 index 000000000..c7ab43b83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse', 'BetaAccessRequestResponse'] +slug: /tools/sdk/python/beta/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'BetaAccessRequestResponse'] +--- + +# AccessRequestResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**existing_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_response import AccessRequestResponse + +access_request_response = AccessRequestResponse( +new_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}], +existing_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse1.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..aa90fc8af --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse1.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse1', 'BetaAccessRequestResponse1'] +slug: /tools/sdk/python/beta/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'BetaAccessRequestResponse1'] +--- + +# AccessRequestResponse1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requester_id** | **str** | the requester Id | [optional] +**requester_name** | **str** | the requesterName | [optional] +**items** | [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_response1 import AccessRequestResponse1 + +access_request_response1 = AccessRequestResponse1( +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}]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestTracking.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestTracking.md new file mode 100644 index 000000000..35e55430d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestTracking.md @@ -0,0 +1,42 @@ +--- +id: beta-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestTracking', 'BetaAccessRequestTracking'] +slug: /tools/sdk/python/beta/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'BetaAccessRequestTracking'] +--- + +# AccessRequestTracking + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **str** | The identity id in which the access request is for. | [optional] +**requested_items_details** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**attributes_hash** | **str** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**access_request_ids** | **[]str** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_request_tracking import AccessRequestTracking + +access_request_tracking = AccessRequestTracking( +requested_for='2c918084660f45d6016617daa9210584', +requested_items_details={ +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" + }, +attributes_hash='-1928438224', +access_request_ids=[5d3118c518a44ec7805450d53479ccdb] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestType.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestType.md new file mode 100644 index 000000000..7fa331576 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestType.md @@ -0,0 +1,23 @@ +--- +id: beta-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestType', 'BetaAccessRequestType'] +slug: /tools/sdk/python/beta/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'BetaAccessRequestType'] +--- + +# AccessRequestType + +Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. + +## Enum + +* `GRANT_ACCESS` (value: `'GRANT_ACCESS'`) + +* `REVOKE_ACCESS` (value: `'REVOKE_ACCESS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequested.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequested.md new file mode 100644 index 000000000..4219810ec --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequested.md @@ -0,0 +1,42 @@ +--- +id: beta-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequested', 'BetaAccessRequested'] +slug: /tools/sdk/python/beta/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequested'] +--- + +# AccessRequested + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional] +**identity_id** | **str** | the identity id | [optional] +**event_type** | **str** | the event type | [optional] +**dt** | **str** | the date of event | [optional] +} + +## Example + +```python +from sailpoint.beta.models.access_requested import AccessRequested + +access_requested = AccessRequested( +access_request=sailpoint.beta.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}]}], ), +identity_id='8a80828f643d484f01643e14202e206f', +event_type='AccessRequested', +dt='2019-03-08T22:37:33.901Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessType.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessType.md new file mode 100644 index 000000000..f0f33cce6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessType.md @@ -0,0 +1,23 @@ +--- +id: beta-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessType', 'BetaAccessType'] +slug: /tools/sdk/python/beta/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'BetaAccessType'] +--- + +# AccessType + +Access type of API Client indicating online or offline use + +## Enum + +* `ONLINE` (value: `'ONLINE'`) + +* `OFFLINE` (value: `'OFFLINE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Account.md b/docs/tools/sdk/python/Reference/Beta/Models/Account.md new file mode 100644 index 000000000..76e17b0fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Account.md @@ -0,0 +1,98 @@ +--- +id: beta-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account', 'BetaAccount'] +slug: /tools/sdk/python/beta/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount'] +--- + +# Account + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**source_id** | **str** | The unique ID of the source this account belongs to | [required] +**source_name** | **str** | The display name of the source this account belongs to | [required] +**identity_id** | **str** | The unique ID of the identity this account is correlated to | [optional] +**cloud_lifecycle_state** | **str** | The lifecycle state of the identity this account is correlated to | [optional] +**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional] +**connection_type** | **str** | The connection type of the source this account is from | [optional] +**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False] +**recommendation** | [**Recommendation**](recommendation) | | [optional] +**attributes** | **map[string]object** | The account attributes that are aggregated | [required] +**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required] +**description** | **str** | A description of the account | [optional] +**disabled** | **bool** | Indicates if the account is currently disabled | [required] +**locked** | **bool** | Indicates if the account is currently locked | [required] +**native_identity** | **str** | The unique ID of the account generated by the source system | [required] +**system_account** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required] +**uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | [required] +**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional] +**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required] +**has_entitlements** | **bool** | Indicates if the account has entitlements | [required] +**identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +**source_owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +**features** | **str** | A string list containing the owning source's features | [optional] +**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional] +**owner_identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account import Account + +account = Account( +id='id12345', +name='aName', +created='2023-01-03T21:16:22.432Z', +modified='2023-01-03T21:16:22.432Z', +source_id='2c9180835d2e5168015d32f890ca1581', +source_name='Employees', +identity_id='2c9180835d2e5168015d32f890ca1581', +cloud_lifecycle_state='active', +identity_state='ACTIVE', +connection_type='direct', +is_machine=True, +recommendation=sailpoint.beta.models.recommendation.Recommendation( + type = 'MACHINE', + method = 'DISCOVERY', ), +attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support}, +authoritative=False, +description='', +disabled=False, +locked=False, +native_identity='552775', +system_account=False, +uncorrelated=False, +uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}', +manually_correlated=False, +has_entitlements=True, +identity=sailpoint.beta.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +source_owner=sailpoint.beta.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +features='ENABLE', +origin='AGGREGATED', +owner_identity=sailpoint.beta.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAction.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAction.md new file mode 100644 index 000000000..71035797f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAction.md @@ -0,0 +1,35 @@ +--- +id: beta-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAction', 'BetaAccountAction'] +slug: /tools/sdk/python/beta/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'BetaAccountAction'] +--- + +# AccountAction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **Enum** [ 'ENABLE', 'DISABLE' ] | Describes if action will be enabled or disabled | [optional] +**source_ids** | **[]str** | List of source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_action import AccountAction + +account_action = AccountAction( +action='ENABLE', +source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..588785aa5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,31 @@ +--- +id: beta-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus'] +slug: /tools/sdk/python/beta/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +The state of an approval status + +## Enum + +* `FINISHED` (value: `'FINISHED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `RETURNED` (value: `'RETURNED'`) + +* `EXPIRED` (value: `'EXPIRED'`) + +* `PENDING` (value: `'PENDING'`) + +* `CANCELED` (value: `'CANCELED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItem.md new file mode 100644 index 000000000..5d5b4eab2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItem.md @@ -0,0 +1,78 @@ +--- +id: beta-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityItem', 'BetaAccountActivityItem'] +slug: /tools/sdk/python/beta/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'BetaAccountActivityItem'] +--- + +# AccountActivityItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Item id | [optional] +**name** | **str** | Human-readable display name of item | [optional] +**requested** | **datetime** | Date and time item was requested | [optional] +**approval_status** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**provisioning_status** | [**ProvisioningState**](provisioning-state) | | [optional] +**requester_comment** | [**Comment**](comment) | | [optional] +**reviewer_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**reviewer_comment** | [**Comment**](comment) | | [optional] +**operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**attribute** | **str** | Attribute to which account activity applies | [optional] +**value** | **str** | Value of attribute | [optional] +**native_identity** | **str** | Native identity in the target system to which the account activity applies | [optional] +**source_id** | **str** | Id of Source to which account activity applies | [optional] +**account_request_info** | [**AccountRequestInfo**](account-request-info) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_activity_item import AccountActivityItem + +account_activity_item = AccountActivityItem( +id='48c545831b264409a81befcabb0e3c5a', +name='48c545831b264409a81befcabb0e3c5a', +requested='2017-07-11T18:45:37.098Z', +approval_status='PENDING', +provisioning_status='PENDING', +requester_comment=sailpoint.beta.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), +reviewer_identity_summary=sailpoint.beta.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +reviewer_comment=sailpoint.beta.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), +operation='ADD', +attribute='detectedRoles', +value='Treasury Analyst [AccessProfile-1529010191212]', +native_identity='Sandie.Camero', +source_id='2c91808363ef85290164000587130c0c', +account_request_info=sailpoint.beta.models.account_request_info.AccountRequestInfo( + requested_object_id = '2c91808563ef85690164001c31140c0c', + requested_object_name = 'Treasury Analyst', + requested_object_type = 'ACCESS_PROFILE', ), +client_metadata={customKey1=custom value 1, customKey2=custom value 2}, +remove_date='2020-07-11T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItemOperation.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..66ff8d269 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItemOperation.md @@ -0,0 +1,39 @@ +--- +id: beta-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation'] +slug: /tools/sdk/python/beta/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +Represents an operation in an account activity item + +## Enum + +* `ADD` (value: `'ADD'`) + +* `CREATE` (value: `'CREATE'`) + +* `MODIFY` (value: `'MODIFY'`) + +* `DELETE` (value: `'DELETE'`) + +* `DISABLE` (value: `'DISABLE'`) + +* `ENABLE` (value: `'ENABLE'`) + +* `UNLOCK` (value: `'UNLOCK'`) + +* `LOCK` (value: `'LOCK'`) + +* `REMOVE` (value: `'REMOVE'`) + +* `SET` (value: `'SET'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregation.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregation.md new file mode 100644 index 000000000..35abf15e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregation.md @@ -0,0 +1,39 @@ +--- +id: beta-account-aggregation +title: AccountAggregation +pagination_label: AccountAggregation +sidebar_label: AccountAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregation', 'BetaAccountAggregation'] +slug: /tools/sdk/python/beta/models/account-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountAggregation', 'BetaAccountAggregation'] +--- + +# AccountAggregation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **datetime** | When the aggregation started. | [optional] +**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED' ] | 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. | [optional] +**total_accounts** | **int** | 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.* | [optional] +**processed_accounts** | **int** | 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.* | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_aggregation import AccountAggregation + +account_aggregation = AccountAggregation( +start='2021-01-31T14:30:05.104Z', +status='ACCOUNTS_COLLECTED', +total_accounts=520, +processed_accounts=150 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompleted.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..4b404702e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompleted.md @@ -0,0 +1,57 @@ +--- +id: beta-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted'] +slug: /tools/sdk/python/beta/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted'] +--- + +# AccountAggregationCompleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required] +**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the aggregation. | [required] +**started** | **datetime** | The date and time when the account aggregation started. | [required] +**completed** | **datetime** | The date and time when the account aggregation finished. | [required] +**errors** | **[]str** | A list of errors that occurred during the aggregation. | [required] +**warnings** | **[]str** | A list of warnings that occurred during the aggregation. | [required] +**stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_aggregation_completed import AccountAggregationCompleted + +account_aggregation_completed = AccountAggregationCompleted( +source=sailpoint.beta.models.account_aggregation_completed_source.AccountAggregationCompleted_source( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +status=Success, +started='2020-06-29T22:01:50.474Z', +completed='2020-06-29T22:02:04.090Z', +errors=[ + 'Accounts unable to be aggregated.' + ], +warnings=[ + 'Account Skipped' + ], +stats=sailpoint.beta.models.account_aggregation_completed_stats.AccountAggregationCompleted_stats( + scanned = 200, + unchanged = 190, + changed = 6, + added = 4, + removed = 3, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..d437ca92b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,38 @@ +--- +id: beta-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource'] +slug: /tools/sdk/python/beta/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource'] +--- + +# AccountAggregationCompletedSource + +The source the accounts are being aggregated from. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being aggregated from. | [required] +**id** | **str** | The ID of the source the accounts are being aggregated from. | [required] +**name** | **str** | Display name of the source the accounts are being aggregated from. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_aggregation_completed_source import AccountAggregationCompletedSource + +account_aggregation_completed_source = AccountAggregationCompletedSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..44e046023 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,42 @@ +--- +id: beta-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats'] +slug: /tools/sdk/python/beta/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats'] +--- + +# AccountAggregationCompletedStats + +Overall statistics about the account aggregation. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required] +**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required] +**changed** | **int** | The number of accounts which existed before, but had changes. | [required] +**added** | **int** | The number of accounts which are new - have not existed before. | [required] +**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_aggregation_completed_stats import AccountAggregationCompletedStats + +account_aggregation_completed_stats = AccountAggregationCompletedStats( +scanned=200, +unchanged=190, +changed=6, +added=4, +removed=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..6a988d9fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationStatus.md @@ -0,0 +1,39 @@ +--- +id: beta-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationStatus', 'BetaAccountAggregationStatus'] +slug: /tools/sdk/python/beta/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'BetaAccountAggregationStatus'] +--- + +# AccountAggregationStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **datetime** | When the aggregation started. | [optional] +**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED' ] | 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. | [optional] +**total_accounts** | **int** | 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.* | [optional] +**processed_accounts** | **int** | 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.* | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_aggregation_status import AccountAggregationStatus + +account_aggregation_status = AccountAggregationStatus( +start='2021-01-31T14:30:05.104Z', +status='ACCOUNTS_COLLECTED', +total_accounts=520, +processed_accounts=150 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributes.md new file mode 100644 index 000000000..6530cf7c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributes.md @@ -0,0 +1,33 @@ +--- +id: beta-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributes', 'BetaAccountAttributes'] +slug: /tools/sdk/python/beta/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'BetaAccountAttributes'] +--- + +# AccountAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **object** | The schema attribute values for the account | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes import AccountAttributes + +account_attributes = AccountAttributes( +attributes={city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChanged.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..e5f2dc98f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChanged.md @@ -0,0 +1,55 @@ +--- +id: beta-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChanged', 'BetaAccountAttributesChanged'] +slug: /tools/sdk/python/beta/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'BetaAccountAttributesChanged'] +--- + +# AccountAttributesChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required] +**source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required] +**account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required] +**changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed import AccountAttributesChanged + +account_attributes_changed = AccountAttributesChanged( +identity=sailpoint.beta.models.account_attributes_changed_identity.AccountAttributesChanged_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +source=sailpoint.beta.models.account_attributes_changed_source.AccountAttributesChanged_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), +account=sailpoint.beta.models.account_attributes_changed_account.AccountAttributesChanged_account( + id = '52170a74-ca89-11ea-87d0-0242ac130003', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', + name = 'john.doe', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + type = ACCOUNT, ), +changes=[ + sailpoint.beta.models.account_attributes_changed_changes_inner.AccountAttributesChanged_changes_inner( + attribute = 'sn', + old_value = doe, + new_value = ryans, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..60d820e77 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,42 @@ +--- +id: beta-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount'] +slug: /tools/sdk/python/beta/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount'] +--- + +# AccountAttributesChangedAccount + +Details of the account where the attributes changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | SailPoint generated unique identifier. | [required] +**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [required] +**name** | **str** | Name of the account. | [required] +**native_identity** | **str** | Unique ID of the account on the source. | [required] +**type** | **Enum** [ 'ACCOUNT' ] | The type of the account | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed_account import AccountAttributesChangedAccount + +account_attributes_changed_account = AccountAttributesChangedAccount( +id='52170a74-ca89-11ea-87d0-0242ac130003', +uuid='1cb1f07d-3e5a-4431-becd-234fa4306108', +name='john.doe', +native_identity='cn=john.doe,ou=users,dc=acme,dc=com', +type=ACCOUNT +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..781bb4d42 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,37 @@ +--- +id: beta-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner'] +slug: /tools/sdk/python/beta/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner'] +--- + +# AccountAttributesChangedChangesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **str** | The name of the attribute. | [required] +**old_value** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required] +**new_value** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed_changes_inner import AccountAttributesChangedChangesInner + +account_attributes_changed_changes_inner = AccountAttributesChangedChangesInner( +attribute='sn', +old_value=doe, +new_value=ryans +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..2cb1833d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,32 @@ +--- +id: beta-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/python/beta/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue'] +--- + +# AccountAttributesChangedChangesInnerNewValue + +The new value of the attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed_changes_inner_new_value import AccountAttributesChangedChangesInnerNewValue + +account_attributes_changed_changes_inner_new_value = AccountAttributesChangedChangesInnerNewValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..3593f91b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,32 @@ +--- +id: beta-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/python/beta/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue'] +--- + +# AccountAttributesChangedChangesInnerOldValue + +The previous value of the attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed_changes_inner_old_value import AccountAttributesChangedChangesInnerOldValue + +account_attributes_changed_changes_inner_old_value = AccountAttributesChangedChangesInnerOldValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..a9204c853 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity'] +slug: /tools/sdk/python/beta/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity'] +--- + +# AccountAttributesChangedIdentity + +The identity whose account attributes were updated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity whose account attributes were updated. | [required] +**id** | **str** | ID of the identity whose account attributes were updated. | [required] +**name** | **str** | Display name of the identity whose account attributes were updated. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed_identity import AccountAttributesChangedIdentity + +account_attributes_changed_identity = AccountAttributesChangedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..ed14edf57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedSource.md @@ -0,0 +1,38 @@ +--- +id: beta-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource'] +slug: /tools/sdk/python/beta/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource'] +--- + +# AccountAttributesChangedSource + +The source that contains the account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the object to which this reference applies | [required] +**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required] +**name** | **str** | Human-readable display name of the object to which this reference applies | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_changed_source import AccountAttributesChangedSource + +account_attributes_changed_source = AccountAttributesChangedSource( +id='4e4d982dddff4267ab12f0f1e72b5a6d', +type='SOURCE', +name='Corporate Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreate.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..e77cf0b83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreate.md @@ -0,0 +1,33 @@ +--- +id: beta-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreate', 'BetaAccountAttributesCreate'] +slug: /tools/sdk/python/beta/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'BetaAccountAttributesCreate'] +--- + +# AccountAttributesCreate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_create import AccountAttributesCreate + +account_attributes_create = AccountAttributesCreate( +attributes={sourceId=34bfcbe116c9407464af37acbaf7a4dc, city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..300f78fe7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,34 @@ +--- +id: beta-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes'] +slug: /tools/sdk/python/beta/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +The schema attribute values for the account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | Target source to create an account | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_attributes_create_attributes import AccountAttributesCreateAttributes + +account_attributes_create_attributes = AccountAttributesCreateAttributes( +source_id='34bfcbe116c9407464af37acbaf7a4dc' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelated.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelated.md new file mode 100644 index 000000000..cd0be49a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelated.md @@ -0,0 +1,52 @@ +--- +id: beta-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelated', 'BetaAccountCorrelated'] +slug: /tools/sdk/python/beta/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'BetaAccountCorrelated'] +--- + +# AccountCorrelated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required] +**source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required] +**account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required] +**attributes** | **map[string]object** | The attributes associated with the account. Attributes are unique per source. | [required] +**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_correlated import AccountCorrelated + +account_correlated = AccountCorrelated( +identity=sailpoint.beta.models.account_correlated_identity.AccountCorrelated_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +source=sailpoint.beta.models.account_correlated_source.AccountCorrelated_source( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +account=sailpoint.beta.models.account_correlated_account.AccountCorrelated_account( + type = 'ACCOUNT', + id = '98da47c31df444558c211f9b205184f6', + name = 'Brian Mendoza', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ), +attributes={sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]}, +entitlement_count=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..dc0c2be92 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedAccount.md @@ -0,0 +1,42 @@ +--- +id: beta-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount'] +slug: /tools/sdk/python/beta/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount'] +--- + +# AccountCorrelatedAccount + +The correlated account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT' ] | The correlated account's DTO type. | [required] +**id** | **str** | The correlated account's ID. | [required] +**name** | **str** | The correlated account's display name. | [required] +**native_identity** | **str** | Unique ID of the account on the source. | [required] +**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_correlated_account import AccountCorrelatedAccount + +account_correlated_account = AccountCorrelatedAccount( +type='ACCOUNT', +id='98da47c31df444558c211f9b205184f6', +name='Brian Mendoza', +native_identity='cn=john.doe,ou=users,dc=acme,dc=com', +uuid='1cb1f07d-3e5a-4431-becd-234fa4306108' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..db9c29f2b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity'] +slug: /tools/sdk/python/beta/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity'] +--- + +# AccountCorrelatedIdentity + +Identity the account is correlated with. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity the account is correlated with. | [required] +**id** | **str** | ID of the identity the account is correlated with. | [required] +**name** | **str** | Display name of the identity the account is correlated with. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_correlated_identity import AccountCorrelatedIdentity + +account_correlated_identity = AccountCorrelatedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedSource.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..49a6f58bd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedSource.md @@ -0,0 +1,38 @@ +--- +id: beta-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource'] +slug: /tools/sdk/python/beta/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource'] +--- + +# AccountCorrelatedSource + +The source the accounts are being correlated from. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being correlated from. | [required] +**id** | **str** | The ID of the source the accounts are being correlated from. | [required] +**name** | **str** | Display name of the source the accounts are being correlated from. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_correlated_source import AccountCorrelatedSource + +account_correlated_source = AccountCorrelatedSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountInfoDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountInfoDto.md new file mode 100644 index 000000000..7ec642e5d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountInfoDto.md @@ -0,0 +1,37 @@ +--- +id: beta-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountInfoDto', 'BetaAccountInfoDto'] +slug: /tools/sdk/python/beta/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'BetaAccountInfoDto'] +--- + +# AccountInfoDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**native_identity** | **str** | The unique ID of the account generated by the source system | [optional] +**display_name** | **str** | Display name for this account | [optional] +**uuid** | **str** | UUID associated with this account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_info_dto import AccountInfoDto + +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}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountRequestInfo.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountRequestInfo.md new file mode 100644 index 000000000..ff50ea6fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountRequestInfo.md @@ -0,0 +1,38 @@ +--- +id: beta-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequestInfo', 'BetaAccountRequestInfo'] +slug: /tools/sdk/python/beta/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'BetaAccountRequestInfo'] +--- + +# AccountRequestInfo + +If an account activity item is associated with an access request, captures details of that request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_object_id** | **str** | Id of requested object | [optional] +**requested_object_name** | **str** | Human-readable name of requested object | [optional] +**requested_object_type** | [**RequestableObjectType**](requestable-object-type) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_request_info import AccountRequestInfo + +account_request_info = AccountRequestInfo( +requested_object_id='2c91808563ef85690164001c31140c0c', +requested_object_name='Treasury Analyst', +requested_object_type='ACCESS_PROFILE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChanged.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChanged.md new file mode 100644 index 000000000..9c3cb48fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChanged.md @@ -0,0 +1,50 @@ +--- +id: beta-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountStatusChanged', 'BetaAccountStatusChanged'] +slug: /tools/sdk/python/beta/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'BetaAccountStatusChanged'] +--- + +# AccountStatusChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **str** | the event type | [optional] +**identity_id** | **str** | the identity id | [optional] +**dt** | **str** | the date of event | [optional] +**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_status_changed import AccountStatusChanged + +account_status_changed = AccountStatusChanged( +event_type='', +identity_id='', +dt='', +account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account( + id = '', + native_identity = '', + display_name = '', + source_id = '', + source_name = '', + entitlement_count = 56, + access_type = '', ), +status_change=sailpoint.beta.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/Beta/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..cac30a376 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedAccount.md @@ -0,0 +1,45 @@ +--- +id: beta-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount'] +slug: /tools/sdk/python/beta/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount'] +--- + +# AccountStatusChangedAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the ID of the account in the database | [optional] +**native_identity** | **str** | the native identifier of the account | [optional] +**display_name** | **str** | the display name of the account | [optional] +**source_id** | **str** | the ID of the source for this account | [optional] +**source_name** | **str** | the name of the source for this account | [optional] +**entitlement_count** | **int** | the number of entitlements on this account | [optional] +**access_type** | **str** | this value is always \"account\" | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_status_changed_account import AccountStatusChangedAccount + +account_status_changed_account = AccountStatusChangedAccount( +id='', +native_identity='', +display_name='', +source_id='', +source_name='', +entitlement_count=56, +access_type='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..ca28ade88 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,35 @@ +--- +id: beta-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange'] +slug: /tools/sdk/python/beta/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange'] +--- + +# AccountStatusChangedStatusChange + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the previous status of the account | [optional] +**new_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the new status of the account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_status_changed_status_change import AccountStatusChangedStatusChange + +account_status_changed_status_change = AccountStatusChangedStatusChange( +previous_status='enabled', +new_status='enabled' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountToggleRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountToggleRequest.md new file mode 100644 index 000000000..82aad0376 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountToggleRequest.md @@ -0,0 +1,36 @@ +--- +id: beta-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountToggleRequest', 'BetaAccountToggleRequest'] +slug: /tools/sdk/python/beta/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'BetaAccountToggleRequest'] +--- + +# AccountToggleRequest + +Request used for account enable/disable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**force_provisioning** | **bool** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_toggle_request import AccountToggleRequest + +account_toggle_request = AccountToggleRequest( +external_verification_id='3f9180835d2e5168015d32f890ca1581', +force_provisioning=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelated.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelated.md new file mode 100644 index 000000000..80424fe11 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelated.md @@ -0,0 +1,50 @@ +--- +id: beta-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelated', 'BetaAccountUncorrelated'] +slug: /tools/sdk/python/beta/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'BetaAccountUncorrelated'] +--- + +# AccountUncorrelated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required] +**source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_uncorrelated import AccountUncorrelated + +account_uncorrelated = AccountUncorrelated( +identity=sailpoint.beta.models.account_uncorrelated_identity.AccountUncorrelated_identity( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +source=sailpoint.beta.models.account_uncorrelated_source.AccountUncorrelated_source( + type = 'SOURCE', + id = '2c6180835d191a86015d28455b4b231b', + name = 'Corporate Directory', ), +account=sailpoint.beta.models.account_uncorrelated_account.AccountUncorrelated_account( + type = ACCOUNT, + id = '4dd497e3723e439991cb6d0e478375dd', + name = 'Sadie Jensen', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ), +entitlement_count=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..42531b6b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,42 @@ +--- +id: beta-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount'] +slug: /tools/sdk/python/beta/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount'] +--- + +# AccountUncorrelatedAccount + +Uncorrelated account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT' ] | Uncorrelated account's DTO type. | [required] +**id** | **str** | Uncorrelated account's ID. | [required] +**name** | **str** | Uncorrelated account's display name. | [required] +**native_identity** | **str** | Unique ID of the account on the source. | [required] +**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_uncorrelated_account import AccountUncorrelatedAccount + +account_uncorrelated_account = AccountUncorrelatedAccount( +type=ACCOUNT, +id='4dd497e3723e439991cb6d0e478375dd', +name='Sadie Jensen', +native_identity='cn=john.doe,ou=users,dc=acme,dc=com', +uuid='1cb1f07d-3e5a-4431-becd-234fa4306108' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..c6ea34983 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity'] +slug: /tools/sdk/python/beta/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity'] +--- + +# AccountUncorrelatedIdentity + +Identity the account is uncorrelated with. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity the account is uncorrelated with. | [required] +**id** | **str** | ID of the identity the account is uncorrelated with. | [required] +**name** | **str** | Display name of the identity the account is uncorrelated with. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_uncorrelated_identity import AccountUncorrelatedIdentity + +account_uncorrelated_identity = AccountUncorrelatedIdentity( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..1bf44a0c0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedSource.md @@ -0,0 +1,38 @@ +--- +id: beta-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource'] +slug: /tools/sdk/python/beta/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource'] +--- + +# AccountUncorrelatedSource + +The source the accounts are uncorrelated from. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are uncorrelated from. | [required] +**id** | **str** | The ID of the source the accounts are uncorrelated from. | [required] +**name** | **str** | Display name of the source the accounts are uncorrelated from. | [required] +} + +## Example + +```python +from sailpoint.beta.models.account_uncorrelated_source import AccountUncorrelatedSource + +account_uncorrelated_source = AccountUncorrelatedSource( +type='SOURCE', +id='2c6180835d191a86015d28455b4b231b', +name='Corporate Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUnlockRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..351f7a4a1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUnlockRequest.md @@ -0,0 +1,38 @@ +--- +id: beta-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUnlockRequest', 'BetaAccountUnlockRequest'] +slug: /tools/sdk/python/beta/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'BetaAccountUnlockRequest'] +--- + +# AccountUnlockRequest + +Request used for account unlock + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**unlock_idn_account** | **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**force_provisioning** | **bool** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_unlock_request import AccountUnlockRequest + +account_unlock_request = AccountUnlockRequest( +external_verification_id='3f9180835d2e5168015d32f890ca1581', +unlock_idn_account=False, +force_provisioning=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md new file mode 100644 index 000000000..6d30198f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md @@ -0,0 +1,35 @@ +--- +id: beta-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUsage', 'BetaAccountUsage'] +slug: /tools/sdk/python/beta/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'BetaAccountUsage'] +--- + +# AccountUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional] +**count** | **int** | The number of days within the month that the account was active in a source. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_usage import AccountUsage + +account_usage = AccountUsage( +var_date='Thu Apr 20 20:00:00 EDT 2023', +count=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountsAsyncResult.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..3db394da7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountsAsyncResult.md @@ -0,0 +1,34 @@ +--- +id: beta-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsAsyncResult', 'BetaAccountsAsyncResult'] +slug: /tools/sdk/python/beta/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'BetaAccountsAsyncResult'] +--- + +# AccountsAsyncResult + +Accounts async response containing details on started async process + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the task | [required] +} + +## Example + +```python +from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult + +accounts_async_result = AccountsAsyncResult( +id='2c91808474683da6017468693c260195' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..8936e7b82 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,57 @@ +--- +id: beta-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation'] +slug: /tools/sdk/python/beta/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation'] +--- + +# AccountsCollectedForAggregation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required] +**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the collection. | [required] +**started** | **datetime** | The date and time when the account collection started. | [required] +**completed** | **datetime** | The date and time when the account collection finished. | [required] +**errors** | **[]str** | A list of errors that occurred during the collection. | [required] +**warnings** | **[]str** | A list of warnings that occurred during the collection. | [required] +**stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.accounts_collected_for_aggregation import AccountsCollectedForAggregation + +accounts_collected_for_aggregation = AccountsCollectedForAggregation( +source=sailpoint.beta.models.accounts_collected_for_aggregation_source.AccountsCollectedForAggregation_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), +status=Success, +started='2020-06-29T22:01:50.474Z', +completed='2020-06-29T22:02:04.090Z', +errors=[ + 'Unable to collect accounts for aggregation.' + ], +warnings=[ + 'Account Skipped' + ], +stats=sailpoint.beta.models.accounts_collected_for_aggregation_stats.AccountsCollectedForAggregation_stats( + scanned = 200, + unchanged = 190, + changed = 6, + added = 4, + removed = 3, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..4446c6a1f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,38 @@ +--- +id: beta-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource'] +slug: /tools/sdk/python/beta/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource'] +--- + +# AccountsCollectedForAggregationSource + +Reference to the source that has been aggregated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the object to which this reference applies | [required] +**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required] +**name** | **str** | Human-readable display name of the object to which this reference applies | [required] +} + +## Example + +```python +from sailpoint.beta.models.accounts_collected_for_aggregation_source import AccountsCollectedForAggregationSource + +accounts_collected_for_aggregation_source = AccountsCollectedForAggregationSource( +id='4e4d982dddff4267ab12f0f1e72b5a6d', +type='SOURCE', +name='Corporate Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..db7287b17 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,42 @@ +--- +id: beta-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats'] +slug: /tools/sdk/python/beta/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats'] +--- + +# AccountsCollectedForAggregationStats + +Overall statistics about the account collection. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required] +**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required] +**changed** | **int** | The number of accounts which existed before, but had changes. | [required] +**added** | **int** | The number of accounts which are new - have not existed before. | [required] +**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] +} + +## Example + +```python +from sailpoint.beta.models.accounts_collected_for_aggregation_stats import AccountsCollectedForAggregationStats + +accounts_collected_for_aggregation_stats = AccountsCollectedForAggregationStats( +scanned=200, +unchanged=190, +changed=6, +added=4, +removed=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ActivateCampaignOptions.md b/docs/tools/sdk/python/Reference/Beta/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..95b0e2517 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ActivateCampaignOptions.md @@ -0,0 +1,33 @@ +--- +id: beta-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivateCampaignOptions', 'BetaActivateCampaignOptions'] +slug: /tools/sdk/python/beta/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'BetaActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time_zone** | **str** | 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. | [optional] [default to 'Z'] +} + +## Example + +```python +from sailpoint.beta.models.activate_campaign_options import ActivateCampaignOptions + +activate_campaign_options = ActivateCampaignOptions( +time_zone='Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AdminReviewReassign.md b/docs/tools/sdk/python/Reference/Beta/Models/AdminReviewReassign.md new file mode 100644 index 000000000..7217d4675 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AdminReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: beta-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AdminReviewReassign', 'BetaAdminReviewReassign'] +slug: /tools/sdk/python/beta/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'BetaAdminReviewReassign'] +--- + +# AdminReviewReassign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification_ids** | **[]str** | List of certification IDs to reassign | [optional] +**reassign_to** | [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**reason** | **str** | Comment to explain why the certification was reassigned | [optional] +} + +## Example + +```python +from sailpoint.beta.models.admin_review_reassign import AdminReviewReassign + +admin_review_reassign = AdminReviewReassign( +certification_ids=[af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3], +reassign_to=sailpoint.beta.models.admin_review_reassign_reassign_to.AdminReviewReassign_reassignTo( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'IDENTITY', ), +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/python/Reference/Beta/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..64d5b1baa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,35 @@ +--- +id: beta-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AdminReviewReassignReassignTo', 'BetaAdminReviewReassignReassignTo'] +slug: /tools/sdk/python/beta/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'BetaAdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID to which the review is being assigned. | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the ID provided. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.admin_review_reassign_reassign_to import AdminReviewReassignReassignTo + +admin_review_reassign_reassign_to = AdminReviewReassignReassignTo( +id='ef38f94347e94562b5bb8424a56397d8', +type='IDENTITY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AppAccountDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/AppAccountDetails.md new file mode 100644 index 000000000..192222aad --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AppAccountDetails.md @@ -0,0 +1,42 @@ +--- +id: beta-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AppAccountDetails', 'BetaAppAccountDetails'] +slug: /tools/sdk/python/beta/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'BetaAppAccountDetails'] +--- + +# AppAccountDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_id** | **str** | The source app ID | [optional] +**app_display_name** | **str** | The source app display name | [optional] +**source_account** | [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.app_account_details import AppAccountDetails + +app_account_details = AppAccountDetails( +app_id='fbf4f72280304f1a8bc808fc2a3bcf7b', +app_display_name='AD source app', +source_account=sailpoint.beta.models.app_account_details_source_account.AppAccountDetails_sourceAccount( + id = 'fbf4f72280304f1a8bc808fc2a3bcf7b', + native_identity = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + display_name = 'Abby Smith', + source_id = '10efa58ea3954883b52bf74f489ce8f9', + source_display_name = 'ODS-AD-SOURCE', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..2bef6747b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,41 @@ +--- +id: beta-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AppAccountDetailsSourceAccount', 'BetaAppAccountDetailsSourceAccount'] +slug: /tools/sdk/python/beta/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'BetaAppAccountDetailsSourceAccount'] +--- + +# AppAccountDetailsSourceAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The account ID | [optional] +**native_identity** | **str** | The native identity of account | [optional] +**display_name** | **str** | The display name of account | [optional] +**source_id** | **str** | The source ID of account | [optional] +**source_display_name** | **str** | The source name of account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.app_account_details_source_account import AppAccountDetailsSourceAccount + +app_account_details_source_account = AppAccountDetailsSourceAccount( +id='fbf4f72280304f1a8bc808fc2a3bcf7b', +native_identity='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +display_name='Abby Smith', +source_id='10efa58ea3954883b52bf74f489ce8f9', +source_display_name='ODS-AD-SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Approval.md b/docs/tools/sdk/python/Reference/Beta/Models/Approval.md new file mode 100644 index 000000000..9616bdd15 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Approval.md @@ -0,0 +1,101 @@ +--- +id: beta-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Approval', 'BetaApproval'] +slug: /tools/sdk/python/beta/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'BetaApproval'] +--- + +# Approval + +Approval Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_id** | **str** | The Approval ID | [optional] +**approvers** | [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**created_date** | **str** | Date the approval was created | [optional] +**type** | **str** | Type of approval | [optional] +**name** | [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**batch_request** | [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**priority** | **Enum** [ 'HIGH', 'MEDIUM', 'LOW' ] | The priority of the approval | [optional] +**requester** | [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**comments** | [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional] +**approved_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**rejected_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**completed_date** | **str** | Date the approval was completed | [optional] +**approval_criteria** | **Enum** [ 'SINGLE', 'DOUBLE', 'TRIPLE', 'QUARTER', 'HALF', 'ALL' ] | Criteria that needs to be met for an approval to be marked as approved | [optional] +**status** | **Enum** [ 'PENDING', 'APPROVED', 'REJECTED' ] | The current status of the approval | [optional] +**additional_attributes** | **str** | Json string representing additional attributes known about the object to be approved. | [optional] +**reference_data** | [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval import Approval + +approval = Approval( +approval_id='38453251-6be2-5f8f-df93-5ce19e295837', +approvers=[ + sailpoint.beta.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ) + ], +created_date='2023-04-12T23:20:50.52Z', +type='ENTITLEMENT_DESCRIPTIONS', +name=[ + sailpoint.beta.models.approval_name.ApprovalName( + value = 'Audit DB Access', + locale = 'en_US', ) + ], +batch_request={batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100}, +description=[ + sailpoint.beta.models.approval_description.ApprovalDescription( + value = 'This access allows viewing and editing of workflow resource', + locale = 'en_US', ) + ], +priority='HIGH', +requester={id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe}, +comments=[ + sailpoint.beta.models.approval_comment.ApprovalComment( + author = sailpoint.beta.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ), + comment = 'Looks good', + created_date = '2023-04-12T23:20:50.52Z', ) + ], +approved_by=[ + sailpoint.beta.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ) + ], +rejected_by=[ + sailpoint.beta.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ) + ], +completed_date='2023-04-12T23:20:50.52Z', +approval_criteria='SINGLE', +status='PENDING', +additional_attributes='{ "llm_description": "generated description" }', +reference_data=[ + sailpoint.beta.models.approval_reference.ApprovalReference( + id = '64012350-8fd9-4f6c-a170-1fe123683899', + type = 'AccessRequestId', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalBatch.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalBatch.md new file mode 100644 index 000000000..f003dcd57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalBatch.md @@ -0,0 +1,36 @@ +--- +id: beta-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalBatch', 'BetaApprovalBatch'] +slug: /tools/sdk/python/beta/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'BetaApprovalBatch'] +--- + +# ApprovalBatch + +Batch properties if an approval is sent via batching. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_id** | **str** | ID of the batch | [optional] +**batch_size** | **int** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_batch import ApprovalBatch + +approval_batch = ApprovalBatch( +batch_id='38453251-6be2-5f8f-df93-5ce19e295837', +batch_size=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalComment.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalComment.md new file mode 100644 index 000000000..58e318d32 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalComment.md @@ -0,0 +1,41 @@ +--- +id: beta-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalComment', 'BetaApprovalComment'] +slug: /tools/sdk/python/beta/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'BetaApprovalComment'] +--- + +# ApprovalComment + +Comments Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**author** | [**ApprovalIdentity**](approval-identity) | | [optional] +**comment** | **str** | Comment to be left on an approval | [optional] +**created_date** | **str** | Date the comment was created | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_comment import ApprovalComment + +approval_comment = ApprovalComment( +author=sailpoint.beta.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ), +comment='Looks good', +created_date='2023-04-12T23:20:50.52Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalDescription.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalDescription.md new file mode 100644 index 000000000..4ff3515c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalDescription.md @@ -0,0 +1,36 @@ +--- +id: beta-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalDescription', 'BetaApprovalDescription'] +slug: /tools/sdk/python/beta/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'BetaApprovalDescription'] +--- + +# ApprovalDescription + +The description of what the approval is asking for + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The description of what the approval is asking for | [optional] +**locale** | **str** | What locale the description of the approval is using | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_description import ApprovalDescription + +approval_description = ApprovalDescription( +value='This access allows viewing and editing of workflow resource', +locale='en_US' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalForwardHistory.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..a020e32b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalForwardHistory.md @@ -0,0 +1,43 @@ +--- +id: beta-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalForwardHistory', 'BetaApprovalForwardHistory'] +slug: /tools/sdk/python/beta/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'BetaApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**old_approver_name** | **str** | Display name of approver from whom the approval was forwarded. | [optional] +**new_approver_name** | **str** | Display name of approver to whom the approval was forwarded. | [optional] +**comment** | **str** | Comment made while forwarding. | [optional] +**modified** | **datetime** | Time at which approval was forwarded. | [optional] +**forwarder_name** | **str** | Display name of forwarder who forwarded the approval. | [optional] +**reassignment_type** | [**ReassignmentType**](reassignment-type) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_forward_history import ApprovalForwardHistory + +approval_forward_history = ApprovalForwardHistory( +old_approver_name='Frank Mir', +new_approver_name='Al Volta', +comment='Forwarding from Frank to Al', +modified='2019-08-23T18:52:57.398Z', +forwarder_name='William Wilson', +reassignment_type='AUTOMATIC_REASSIGNMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalIdentity.md new file mode 100644 index 000000000..cd59e86d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalIdentity', 'BetaApprovalIdentity'] +slug: /tools/sdk/python/beta/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'BetaApprovalIdentity'] +--- + +# ApprovalIdentity + +Identity Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**type** | **Enum** [ 'IDENTITY' ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**name** | **str** | Name of the identity | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_identity import ApprovalIdentity + +approval_identity = ApprovalIdentity( +id='85d173e7d57e496569df763231d6deb6a', +type='IDENTITY', +name='John Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalInfoResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..05ae81eae --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalInfoResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalInfoResponse', 'BetaApprovalInfoResponse'] +slug: /tools/sdk/python/beta/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'BetaApprovalInfoResponse'] +--- + +# ApprovalInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of approver | [optional] +**name** | **str** | the name of approver | [optional] +**status** | **str** | the status of the approval request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_info_response import ApprovalInfoResponse + +approval_info_response = ApprovalInfoResponse( +id='8a80828f643d484f01643e14202e2000', +name='John Snow', +status='Approved' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalItemDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..42794a3ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalItemDetails.md @@ -0,0 +1,45 @@ +--- +id: beta-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalItemDetails', 'BetaApprovalItemDetails'] +slug: /tools/sdk/python/beta/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'BetaApprovalItemDetails'] +--- + +# ApprovalItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval item's ID | [optional] +**account** | **str** | The account referenced by the approval item | [optional] +**application** | **str** | The name of the application/source | [optional] +**name** | **str** | The attribute's name | [optional] +**operation** | **str** | The attribute's operation | [optional] +**value** | **str** | The attribute's value | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_item_details import ApprovalItemDetails + +approval_item_details = ApprovalItemDetails( +id='2c9180835d2e5168015d32f890ca1581', +account='john.smith', +application='Active Directory', +name='emailAddress', +operation='update', +value='a@b.com', +state='Pending' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalItems.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalItems.md new file mode 100644 index 000000000..871209436 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalItems.md @@ -0,0 +1,45 @@ +--- +id: beta-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalItems', 'BetaApprovalItems'] +slug: /tools/sdk/python/beta/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'BetaApprovalItems'] +--- + +# ApprovalItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval item's ID | [optional] +**account** | **str** | The account referenced by the approval item | [optional] +**application** | **str** | The name of the application/source | [optional] +**name** | **str** | The attribute's name | [optional] +**operation** | **str** | The attribute's operation | [optional] +**value** | **str** | The attribute's value | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_items import ApprovalItems + +approval_items = ApprovalItems( +id='2c9180835d2e5168015d32f890ca1581', +account='john.smith', +application='Active Directory', +name='emailAddress', +operation='update', +value='a@b.com', +state='Pending' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalName.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalName.md new file mode 100644 index 000000000..70a27bbfc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalName.md @@ -0,0 +1,36 @@ +--- +id: beta-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalName', 'BetaApprovalName'] +slug: /tools/sdk/python/beta/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'BetaApprovalName'] +--- + +# ApprovalName + +Approval Name Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Name of the approval | [optional] +**locale** | **str** | What locale the name of the approval is using | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_name import ApprovalName + +approval_name = ApprovalName( +value='Audit DB Access', +locale='en_US' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalReference.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalReference.md new file mode 100644 index 000000000..8f3dd906e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalReference.md @@ -0,0 +1,36 @@ +--- +id: beta-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalReference', 'BetaApprovalReference'] +slug: /tools/sdk/python/beta/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'BetaApprovalReference'] +--- + +# ApprovalReference + +Reference objects related to the approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the reference object | [optional] +**type** | **str** | What reference object does this ID correspond to | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_reference import ApprovalReference + +approval_reference = ApprovalReference( +id='64012350-8fd9-4f6c-a170-1fe123683899', +type='AccessRequestId' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..4f7eadb4f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,43 @@ +--- +id: beta-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalReminderAndEscalationConfig', 'BetaApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/python/beta/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'BetaApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days_until_escalation** | **int** | 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. | [optional] +**days_between_reminders** | **int** | Number of days to wait between reminder notifications. | [optional] +**max_reminders** | **int** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**fallback_approver_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_reminder_and_escalation_config import ApprovalReminderAndEscalationConfig + +approval_reminder_and_escalation_config = ApprovalReminderAndEscalationConfig( +days_until_escalation=0, +days_between_reminders=0, +max_reminders=1, +fallback_approver_ref=sailpoint.beta.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalScheme.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalScheme.md new file mode 100644 index 000000000..f47c09641 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalScheme.md @@ -0,0 +1,33 @@ +--- +id: beta-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalScheme', 'BetaApprovalScheme'] +slug: /tools/sdk/python/beta/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'BetaApprovalScheme'] +--- + +# ApprovalScheme + +Describes the individual or group that is responsible for an approval step. + +## Enum + +* `APP_OWNER` (value: `'APP_OWNER'`) + +* `SOURCE_OWNER` (value: `'SOURCE_OWNER'`) + +* `MANAGER` (value: `'MANAGER'`) + +* `ROLE_OWNER` (value: `'ROLE_OWNER'`) + +* `ACCESS_PROFILE_OWNER` (value: `'ACCESS_PROFILE_OWNER'`) + +* `ENTITLEMENT_OWNER` (value: `'ENTITLEMENT_OWNER'`) + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..d85c962ca --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalSchemeForRole.md @@ -0,0 +1,35 @@ +--- +id: beta-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalSchemeForRole', 'BetaApprovalSchemeForRole'] +slug: /tools/sdk/python/beta/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'BetaApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | 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 | [optional] +**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_scheme_for_role import ApprovalSchemeForRole + +approval_scheme_for_role = ApprovalSchemeForRole( +approver_type='GOVERNANCE_GROUP', +approver_id='46c79819-a69f-49a2-becb-12c971ae66c6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatus.md new file mode 100644 index 000000000..6474eaaeb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: beta-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatus', 'BetaApprovalStatus'] +slug: /tools/sdk/python/beta/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'BetaApprovalStatus'] +--- + +# ApprovalStatus + +Enum representing the non-employee request approval status + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `PENDING` (value: `'PENDING'`) + +* `NOT_READY` (value: `'NOT_READY'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..96c420c5a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDto.md @@ -0,0 +1,59 @@ +--- +id: beta-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDto', 'BetaApprovalStatusDto'] +slug: /tools/sdk/python/beta/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'BetaApprovalStatusDto'] +--- + +# ApprovalStatusDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_id** | **str** | Unique identifier for the approval. | [optional] +**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False] +**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**modified** | **datetime** | Time at which item was modified. | [optional] +**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**scheme** | [**ApprovalScheme**](approval-scheme) | | [optional] +**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**comment** | **str** | Comment, if any, provided by the approver. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_status_dto import ApprovalStatusDto + +approval_status_dto = ApprovalStatusDto( +approval_id='2c9180877b2b6ea4017b2c545f971429', +forwarded=False, +original_owner=sailpoint.beta.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +current_owner=, +modified='2019-08-23T18:52:57.398Z', +status='PENDING', +scheme='MANAGER', +error_messages=[ + sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], +comment='I approve this request', +remove_date='2020-07-11T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..07a45220f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'BetaApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/python/beta/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'BetaApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_status_dto_current_owner import ApprovalStatusDtoCurrentOwner + +approval_status_dto_current_owner = ApprovalStatusDtoCurrentOwner( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..7cc6b8657 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'BetaApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/python/beta/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'BetaApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +Identity of orginal approval owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original approval owner's identity. | [optional] +**id** | **str** | ID of original approval owner's identity. | [optional] +**name** | **str** | Display name of original approval owner. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_status_dto_original_owner import ApprovalStatusDtoOriginalOwner + +approval_status_dto_original_owner = ApprovalStatusDtoOriginalOwner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ApprovalSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalSummary.md new file mode 100644 index 000000000..a62fa444d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ApprovalSummary.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalSummary', 'BetaApprovalSummary'] +slug: /tools/sdk/python/beta/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'BetaApprovalSummary'] +--- + +# ApprovalSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pending** | **int** | The number of pending access requests approvals. | [optional] +**approved** | **int** | The number of approved access requests approvals. | [optional] +**rejected** | **int** | The number of rejected access requests approvals. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.approval_summary import ApprovalSummary + +approval_summary = ApprovalSummary( +pending=56, +approved=56, +rejected=56 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Argument.md b/docs/tools/sdk/python/Reference/Beta/Models/Argument.md new file mode 100644 index 000000000..bc16e4785 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Argument.md @@ -0,0 +1,37 @@ +--- +id: beta-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Argument', 'BetaArgument'] +slug: /tools/sdk/python/beta/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'BetaArgument'] +--- + +# Argument + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of the argument | [required] +**description** | **str** | the description of the argument | [optional] +**type** | **str** | the programmatic type of the argument | [optional] +} + +## Example + +```python +from sailpoint.beta.models.argument import Argument + +argument = Argument( +name='firstName', +description='the first name of the identity', +type='String' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ArrayInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ArrayInner.md new file mode 100644 index 000000000..92e49e3fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ArrayInner.md @@ -0,0 +1,31 @@ +--- +id: beta-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ArrayInner', 'BetaArrayInner'] +slug: /tools/sdk/python/beta/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'BetaArrayInner'] +--- + +# ArrayInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.array_inner import ArrayInner + +array_inner = ArrayInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ArrayInner1.md b/docs/tools/sdk/python/Reference/Beta/Models/ArrayInner1.md new file mode 100644 index 000000000..3d2cabe40 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ArrayInner1.md @@ -0,0 +1,31 @@ +--- +id: beta-array-inner1 +title: ArrayInner1 +pagination_label: ArrayInner1 +sidebar_label: ArrayInner1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ArrayInner1', 'BetaArrayInner1'] +slug: /tools/sdk/python/beta/models/array-inner1 +tags: ['SDK', 'Software Development Kit', 'ArrayInner1', 'BetaArrayInner1'] +--- + +# ArrayInner1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.array_inner1 import ArrayInner1 + +array_inner1 = ArrayInner1( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AssignmentContextDto.md b/docs/tools/sdk/python/Reference/Beta/Models/AssignmentContextDto.md new file mode 100644 index 000000000..1d203d5b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AssignmentContextDto.md @@ -0,0 +1,54 @@ +--- +id: beta-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AssignmentContextDto', 'BetaAssignmentContextDto'] +slug: /tools/sdk/python/beta/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'BetaAssignmentContextDto'] +--- + +# AssignmentContextDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested** | [**AccessRequestContext**](access-request-context) | | [optional] +**matched** | [**[]RoleMatchDto**](role-match-dto) | | [optional] +**computed_date** | **str** | Date that the assignment will was evaluated | [optional] +} + +## Example + +```python +from sailpoint.beta.models.assignment_context_dto import AssignmentContextDto + +assignment_context_dto = AssignmentContextDto( +requested=sailpoint.beta.models.access_request_context.AccessRequestContext( + context_attributes = [ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ), +matched=[ + sailpoint.beta.models.role_match_dto.RoleMatchDto( + role_ref = sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), + matched_attributes = [ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ) + ], +computed_date='Wed Feb 14 10:58:42' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSource.md b/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSource.md new file mode 100644 index 000000000..2dc808b25 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSource.md @@ -0,0 +1,38 @@ +--- +id: beta-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttrSyncSource', 'BetaAttrSyncSource'] +slug: /tools/sdk/python/beta/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'BetaAttrSyncSource'] +--- + +# AttrSyncSource + +Target source for attribute synchronization. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | DTO type of target source for attribute synchronization. | [optional] +**id** | **str** | ID of target source for attribute synchronization. | [optional] +**name** | **str** | Human-readable name of target source for attribute synchronization. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attr_sync_source import AttrSyncSource + +attr_sync_source = AttrSyncSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..f30abadf4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,40 @@ +--- +id: beta-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttrSyncSourceAttributeConfig', 'BetaAttrSyncSourceAttributeConfig'] +slug: /tools/sdk/python/beta/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'BetaAttrSyncSourceAttributeConfig'] +--- + +# AttrSyncSourceAttributeConfig + +Specification of source attribute sync mapping configuration for an identity attribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the identity attribute | [required] +**display_name** | **str** | Display name of the identity attribute | [required] +**enabled** | **bool** | Determines whether or not the attribute is enabled for synchronization | [required] +**target** | **str** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [required] +} + +## Example + +```python +from sailpoint.beta.models.attr_sync_source_attribute_config import AttrSyncSourceAttributeConfig + +attr_sync_source_attribute_config = AttrSyncSourceAttributeConfig( +name='email', +display_name='Email', +enabled=True, +target='mail' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..340295bfa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttrSyncSourceConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttrSyncSourceConfig', 'BetaAttrSyncSourceConfig'] +slug: /tools/sdk/python/beta/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'BetaAttrSyncSourceConfig'] +--- + +# AttrSyncSourceConfig + +Specification of attribute sync configuration for a source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**AttrSyncSource**](attr-sync-source) | | [required] +**attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | [required] +} + +## Example + +```python +from sailpoint.beta.models.attr_sync_source_config import AttrSyncSourceConfig + +attr_sync_source_config = AttrSyncSourceConfig( +source=sailpoint.beta.models.attr_sync_source.AttrSyncSource( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +attributes=[{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeChange.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeChange.md new file mode 100644 index 000000000..a7959e0d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeChange.md @@ -0,0 +1,37 @@ +--- +id: beta-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeChange', 'BetaAttributeChange'] +slug: /tools/sdk/python/beta/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'BetaAttributeChange'] +--- + +# AttributeChange + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the attribute name | [optional] +**previous_value** | **str** | the old value of attribute | [optional] +**new_value** | **str** | the new value of attribute | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attribute_change import AttributeChange + +attribute_change = AttributeChange( +name='', +previous_value='', +new_value='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDTO.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDTO.md new file mode 100644 index 000000000..b83cc207a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDTO.md @@ -0,0 +1,52 @@ +--- +id: beta-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDTO', 'BetaAttributeDTO'] +slug: /tools/sdk/python/beta/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'BetaAttributeDTO'] +--- + +# AttributeDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**name** | **str** | The display name of the key. | [optional] +**multiselect** | **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to False] +**status** | **str** | The status of the Attribute. | [optional] +**type** | **str** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**object_types** | **[]str** | 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. | [optional] +**description** | **str** | The description of the Attribute. | [optional] +**values** | [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attribute_dto import AttributeDTO + +attribute_dto = AttributeDTO( +key='iscPrivacy', +name='Privacy', +multiselect=False, +status='active', +type='governance', +object_types=[entitlement], +description='Specifies the level of privacy associated with an access item.', +values=[ + sailpoint.beta.models.attribute_value_dto.AttributeValueDTO( + value = 'public', + name = 'Public', + status = 'active', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDTOList.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDTOList.md new file mode 100644 index 000000000..2bebe5ed6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDTOList.md @@ -0,0 +1,33 @@ +--- +id: beta-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDTOList', 'BetaAttributeDTOList'] +slug: /tools/sdk/python/beta/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'BetaAttributeDTOList'] +--- + +# AttributeDTOList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attribute_dto_list import AttributeDTOList + +attribute_dto_list = AttributeDTOList( +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}]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinition.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinition.md new file mode 100644 index 000000000..497618882 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinition.md @@ -0,0 +1,48 @@ +--- +id: beta-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinition', 'BetaAttributeDefinition'] +slug: /tools/sdk/python/beta/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'BetaAttributeDefinition'] +--- + +# AttributeDefinition + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the attribute. | [optional] +**type** | [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**var_schema** | [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**description** | **str** | A human-readable description of the attribute. | [optional] +**is_multi** | **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to False] +**is_entitlement** | **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to False] +**is_group** | **bool** | 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. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.attribute_definition import AttributeDefinition + +attribute_definition = AttributeDefinition( +name='sAMAccountName', +type='STRING', +var_schema=sailpoint.beta.models.attribute_definition_schema.AttributeDefinition_schema( + type = 'CONNECTOR_SCHEMA', + id = '2c91808568c529c60168cca6f90c1313', + name = 'group', ), +description='The sAMAccountName attribute', +is_multi=False, +is_entitlement=False, +is_group=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..22e93f791 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionSchema.md @@ -0,0 +1,38 @@ +--- +id: beta-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionSchema', 'BetaAttributeDefinitionSchema'] +slug: /tools/sdk/python/beta/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'BetaAttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +A reference to the schema on the source to the attribute values map to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | The type of object being referenced | [optional] +**id** | **str** | The object ID this reference applies to. | [optional] +**name** | **str** | The human-readable display name of the object. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attribute_definition_schema import AttributeDefinitionSchema + +attribute_definition_schema = AttributeDefinitionSchema( +type='CONNECTOR_SCHEMA', +id='2c91808568c529c60168cca6f90c1313', +name='group' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..8118f5155 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: beta-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionType', 'BetaAttributeDefinitionType'] +slug: /tools/sdk/python/beta/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'BetaAttributeDefinitionType'] +--- + +# AttributeDefinitionType + +The underlying type of the value which an AttributeDefinition represents. + +## Enum + +* `STRING` (value: `'STRING'`) + +* `LONG` (value: `'LONG'`) + +* `INT` (value: `'INT'`) + +* `BOOLEAN` (value: `'BOOLEAN'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeValueDTO.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeValueDTO.md new file mode 100644 index 000000000..aca08de7b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeValueDTO.md @@ -0,0 +1,37 @@ +--- +id: beta-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeValueDTO', 'BetaAttributeValueDTO'] +slug: /tools/sdk/python/beta/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'BetaAttributeValueDTO'] +--- + +# AttributeValueDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**name** | **str** | The display name of the Attribute value. | [optional] +**status** | **str** | The status of the Attribute value. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO + +attribute_value_dto = AttributeValueDTO( +value='public', +name='Public', +status='active' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributesChanged.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributesChanged.md new file mode 100644 index 000000000..0958f8964 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributesChanged.md @@ -0,0 +1,41 @@ +--- +id: beta-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributesChanged', 'BetaAttributesChanged'] +slug: /tools/sdk/python/beta/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'BetaAttributesChanged'] +--- + +# AttributesChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**changes** | [**[]AttributeChange**](attribute-change) | | [optional] +**event_type** | **str** | the event type | [optional] +**identity_id** | **str** | the identity id | [optional] +**dt** | **str** | the date of event | [optional] +} + +## Example + +```python +from sailpoint.beta.models.attributes_changed import AttributesChanged + +attributes_changed = AttributesChanged( +changes=[ + {name=firstname, previousValue=adam, newValue=zampa} + ], +event_type='', +identity_id='', +dt='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AuditDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/AuditDetails.md new file mode 100644 index 000000000..3742755b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AuditDetails.md @@ -0,0 +1,44 @@ +--- +id: beta-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuditDetails', 'BetaAuditDetails'] +slug: /tools/sdk/python/beta/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'BetaAuditDetails'] +--- + +# AuditDetails + +Audit details for the reassignment configuration of an identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | Initial date and time when the record was created | [optional] +**created_by** | [**Identity1**](identity1) | | [optional] +**modified** | **datetime** | Last modified date and time for the record | [optional] +**modified_by** | [**Identity1**](identity1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.audit_details import AuditDetails + +audit_details = AuditDetails( +created='2022-07-21T11:13:12.345Z', +created_by=sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +modified='2022-07-21T11:13:12.345Z', +modified_by=sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AuthProfile.md b/docs/tools/sdk/python/Reference/Beta/Models/AuthProfile.md new file mode 100644 index 000000000..20e7edf90 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AuthProfile.md @@ -0,0 +1,45 @@ +--- +id: beta-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuthProfile', 'BetaAuthProfile'] +slug: /tools/sdk/python/beta/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'BetaAuthProfile'] +--- + +# AuthProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Authentication Profile name. | [optional] +**off_network** | **bool** | Use it to block access from off network. | [optional] [default to False] +**untrusted_geography** | **bool** | Use it to block access from untrusted geoographies. | [optional] [default to False] +**application_id** | **str** | Application ID. | [optional] +**application_name** | **str** | Application name. | [optional] +**type** | **Enum** [ 'BLOCK', 'MFA', 'NON_PTA', 'PTA' ] | Type of the Authentication Profile. | [optional] +**strong_auth_login** | **bool** | Use it to enable strong authentication. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.auth_profile import AuthProfile + +auth_profile = AuthProfile( +name='EndToEnd-Profile', +off_network=True, +untrusted_geography=True, +application_id='2c91808458ae7a4f0158b1bbf8af0628', +application_name='EndToEnd-Source', +type='PTA', +strong_auth_login=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AuthProfileSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/AuthProfileSummary.md new file mode 100644 index 000000000..6b4566621 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AuthProfileSummary.md @@ -0,0 +1,35 @@ +--- +id: beta-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuthProfileSummary', 'BetaAuthProfileSummary'] +slug: /tools/sdk/python/beta/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'BetaAuthProfileSummary'] +--- + +# AuthProfileSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenant** | **str** | Tenant name. | [optional] +**id** | **str** | Identity ID. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.auth_profile_summary import AuthProfileSummary + +auth_profile_summary = AuthProfileSummary( +tenant='test-tenant', +id='2c91808458ae7a4f0158b1bbf8af0628' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BaseCommonDto.md b/docs/tools/sdk/python/Reference/Beta/Models/BaseCommonDto.md new file mode 100644 index 000000000..7a7796201 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BaseCommonDto.md @@ -0,0 +1,39 @@ +--- +id: beta-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseCommonDto', 'BetaBaseCommonDto'] +slug: /tools/sdk/python/beta/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BetaBaseCommonDto'] +--- + +# BaseCommonDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.base_common_dto import BaseCommonDto + +base_common_dto = BaseCommonDto( +id='id12345', +name='aName', +created='2023-01-03T21:16:22.432Z', +modified='2023-01-03T21:16:22.432Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BaseCommonDto1.md b/docs/tools/sdk/python/Reference/Beta/Models/BaseCommonDto1.md new file mode 100644 index 000000000..ec6d89ba7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BaseCommonDto1.md @@ -0,0 +1,39 @@ +--- +id: beta-base-common-dto1 +title: BaseCommonDto1 +pagination_label: BaseCommonDto1 +sidebar_label: BaseCommonDto1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseCommonDto1', 'BetaBaseCommonDto1'] +slug: /tools/sdk/python/beta/models/base-common-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'BetaBaseCommonDto1'] +--- + +# BaseCommonDto1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.base_common_dto1 import BaseCommonDto1 + +base_common_dto1 = BaseCommonDto1( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BaseReferenceDto.md b/docs/tools/sdk/python/Reference/Beta/Models/BaseReferenceDto.md new file mode 100644 index 000000000..48643f5fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BaseReferenceDto.md @@ -0,0 +1,37 @@ +--- +id: beta-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto', 'BetaBaseReferenceDto'] +slug: /tools/sdk/python/beta/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BetaBaseReferenceDto'] +--- + +# BaseReferenceDto + + +## 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] +} + +## Example + +```python +from sailpoint.beta.models.base_reference_dto import BaseReferenceDto + +base_reference_dto = BaseReferenceDto( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BaseReferenceDto1.md b/docs/tools/sdk/python/Reference/Beta/Models/BaseReferenceDto1.md new file mode 100644 index 000000000..cc2ce1f83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BaseReferenceDto1.md @@ -0,0 +1,35 @@ +--- +id: beta-base-reference-dto1 +title: BaseReferenceDto1 +pagination_label: BaseReferenceDto1 +sidebar_label: BaseReferenceDto1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto1', 'BetaBaseReferenceDto1'] +slug: /tools/sdk/python/beta/models/base-reference-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'BetaBaseReferenceDto1'] +--- + +# BaseReferenceDto1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the application ID | [optional] +**name** | **str** | the application name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.base_reference_dto1 import BaseReferenceDto1 + +base_reference_dto1 = BaseReferenceDto1( +id='ff8081814d977c21014da056804a0af3', +name='Github' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BasicAuthConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/BasicAuthConfig.md new file mode 100644 index 000000000..62104f70a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BasicAuthConfig.md @@ -0,0 +1,36 @@ +--- +id: beta-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BasicAuthConfig', 'BetaBasicAuthConfig'] +slug: /tools/sdk/python/beta/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'BetaBasicAuthConfig'] +--- + +# BasicAuthConfig + +Config required if BASIC_AUTH is used. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | The username to authenticate. | [optional] +**password** | **str** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.basic_auth_config import BasicAuthConfig + +basic_auth_config = BasicAuthConfig( +user_name='user@example.com', +password='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..0a6574d29 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BearerTokenAuthConfig.md @@ -0,0 +1,34 @@ +--- +id: beta-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BearerTokenAuthConfig', 'BetaBearerTokenAuthConfig'] +slug: /tools/sdk/python/beta/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'BetaBearerTokenAuthConfig'] +--- + +# BearerTokenAuthConfig + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bearer_token** | **str** | Bearer token | [optional] +} + +## Example + +```python +from sailpoint.beta.models.bearer_token_auth_config import BearerTokenAuthConfig + +bearer_token_auth_config = BearerTokenAuthConfig( +bearer_token='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/python/Reference/Beta/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..85506c7e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,38 @@ +--- +id: beta-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BeforeProvisioningRuleDto', 'BetaBeforeProvisioningRuleDto'] +slug: /tools/sdk/python/beta/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BetaBeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +Before Provisioning Rule. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Before Provisioning Rule DTO type. | [optional] +**id** | **str** | Before Provisioning Rule ID. | [optional] +**name** | **str** | Rule display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.before_provisioning_rule_dto import BeforeProvisioningRuleDto + +before_provisioning_rule_dto = BeforeProvisioningRuleDto( +type='RULE', +id='048eb3d55c5a4758bd07dccb87741c78', +name='Before Provisioning Airtable Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..af197370e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,38 @@ +--- +id: beta-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkIdentitiesAccountsResponse', 'BetaBulkIdentitiesAccountsResponse'] +slug: /tools/sdk/python/beta/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'BetaBulkIdentitiesAccountsResponse'] +--- + +# BulkIdentitiesAccountsResponse + +Bulk response object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of bulk request item. | [optional] +**status_code** | **int** | Response status value. | [optional] +**message** | **str** | Status containing additional context information about failures. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse + +bulk_identities_accounts_response = BulkIdentitiesAccountsResponse( +id='2c9180858082150f0180893dbaf553fe', +status_code=404, +message='Referenced identity "2c9180858082150f0180893dbaf553fe" was not found.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BulkTaggedObject.md b/docs/tools/sdk/python/Reference/Beta/Models/BulkTaggedObject.md new file mode 100644 index 000000000..a35d41670 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BulkTaggedObject.md @@ -0,0 +1,42 @@ +--- +id: beta-bulk-tagged-object +title: BulkTaggedObject +pagination_label: BulkTaggedObject +sidebar_label: BulkTaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkTaggedObject', 'BetaBulkTaggedObject'] +slug: /tools/sdk/python/beta/models/bulk-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObject', 'BetaBulkTaggedObject'] +--- + +# BulkTaggedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to object. | [optional] +**operation** | **Enum** [ 'APPEND', 'MERGE' ] | 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. | [optional] [default to 'APPEND'] +} + +## Example + +```python +from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject + +bulk_tagged_object = BulkTaggedObject( +object_refs=[ + sailpoint.beta.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI], +operation='APPEND' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/BulkWorkgroupMembersRequestInner.md b/docs/tools/sdk/python/Reference/Beta/Models/BulkWorkgroupMembersRequestInner.md new file mode 100644 index 000000000..d171c92b6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/BulkWorkgroupMembersRequestInner.md @@ -0,0 +1,38 @@ +--- +id: beta-bulk-workgroup-members-request-inner +title: BulkWorkgroupMembersRequestInner +pagination_label: BulkWorkgroupMembersRequestInner +sidebar_label: BulkWorkgroupMembersRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkWorkgroupMembersRequestInner', 'BetaBulkWorkgroupMembersRequestInner'] +slug: /tools/sdk/python/beta/models/bulk-workgroup-members-request-inner +tags: ['SDK', 'Software Development Kit', 'BulkWorkgroupMembersRequestInner', 'BetaBulkWorkgroupMembersRequestInner'] +--- + +# BulkWorkgroupMembersRequestInner + +Identity's basic details. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Identity's DTO type. | [optional] +**id** | **str** | Identity ID. | [optional] +**name** | **str** | Identity's display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner + +bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Campaign.md b/docs/tools/sdk/python/Reference/Beta/Models/Campaign.md new file mode 100644 index 000000000..c7c370eaa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Campaign.md @@ -0,0 +1,122 @@ +--- +id: beta-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Campaign', 'BetaCampaign'] +slug: /tools/sdk/python/beta/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'BetaCampaign'] +--- + +# Campaign + + +## 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** | [**FullcampaignAllOfFilter**](fullcampaign-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** | [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-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.beta.models.campaign import Campaign + +campaign = Campaign( +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.beta.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.beta.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.beta.models.fullcampaign_all_of_filter.fullcampaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.beta.models.fullcampaign_all_of_source_owner_campaign_info.fullcampaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.beta.models.fullcampaign_all_of_search_campaign_info.fullcampaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.beta.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info.fullcampaign_allOf_roleCompositionCampaignInfo( + reviewer = sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info_remediator_ref.fullcampaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.beta.models.fullcampaign_all_of_machine_account_campaign_info.fullcampaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.beta.models.fullcampaign_all_of_sources_with_orphan_entitlements.fullcampaign_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/Beta/Models/CampaignActivated.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivated.md new file mode 100644 index 000000000..b55e53542 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivated.md @@ -0,0 +1,45 @@ +--- +id: beta-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignActivated', 'BetaCampaignActivated'] +slug: /tools/sdk/python/beta/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'BetaCampaignActivated'] +--- + +# CampaignActivated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_activated import CampaignActivated + +campaign_activated = CampaignActivated( +campaign=sailpoint.beta.models.campaign_activated_campaign.CampaignActivated_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-02-16T03:06:45.815Z', + deadline = '2021-03-16T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = ACTIVE, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..35f64c856 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaign.md @@ -0,0 +1,53 @@ +--- +id: beta-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignActivatedCampaign', 'BetaCampaignActivatedCampaign'] +slug: /tools/sdk/python/beta/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'BetaCampaignActivatedCampaign'] +--- + +# CampaignActivatedCampaign + +Details about the certification campaign that was activated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID for the campaign. | [required] +**name** | **str** | The human friendly name of the campaign. | [required] +**description** | **str** | Extended description of the campaign. | [required] +**created** | **datetime** | The date and time the campaign was created. | [required] +**modified** | **datetime** | The date and time the campaign was last modified. | [optional] +**deadline** | **datetime** | The date and time the campaign is due. | [required] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign. | [required] +**campaign_owner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**status** | **Enum** [ 'ACTIVE' ] | The current status of the campaign. | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_activated_campaign import CampaignActivatedCampaign + +campaign_activated_campaign = CampaignActivatedCampaign( +id='2c91808576f886190176f88cac5a0010', +name='Manager Access Campaign', +description='Audit access for all employees.', +created='2021-02-16T03:04:45.815Z', +modified='2021-02-16T03:06:45.815Z', +deadline='2021-03-16T03:04:45.815Z', +type=MANAGER, +campaign_owner=sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), +status=ACTIVE +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..7eb7f1b7b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'BetaCampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/python/beta/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'BetaCampaignActivatedCampaignCampaignOwner'] +--- + +# CampaignActivatedCampaignCampaignOwner + +Details of the identity that owns the campaign. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity. | [required] +**display_name** | **str** | The human friendly name of the identity. | [required] +**email** | **str** | The primary email address of the identity. | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_activated_campaign_campaign_owner import CampaignActivatedCampaignCampaignOwner + +campaign_activated_campaign_campaign_owner = CampaignActivatedCampaignCampaignOwner( +id='37f080867702c1910177031320c40n27', +display_name='John Snow', +email='john.snow@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignAlert.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignAlert.md new file mode 100644 index 000000000..ae2fc6029 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignAlert.md @@ -0,0 +1,40 @@ +--- +id: beta-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAlert', 'BetaCampaignAlert'] +slug: /tools/sdk/python/beta/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'BetaCampaignAlert'] +--- + +# CampaignAlert + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**level** | **Enum** [ 'ERROR', 'WARN', 'INFO' ] | Denotes the level of the message | [optional] +**localizations** | [**[]ErrorMessageDto**](error-message-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.campaign_alert import CampaignAlert + +campaign_alert = CampaignAlert( +level='ERROR', +localizations=[ + sailpoint.beta.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/Beta/Models/CampaignEnded.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignEnded.md new file mode 100644 index 000000000..11f10b9d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignEnded.md @@ -0,0 +1,45 @@ +--- +id: beta-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignEnded', 'BetaCampaignEnded'] +slug: /tools/sdk/python/beta/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'BetaCampaignEnded'] +--- + +# CampaignEnded + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_ended import CampaignEnded + +campaign_ended = CampaignEnded( +campaign=sailpoint.beta.models.campaign_ended_campaign.CampaignEnded_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-03-16T03:06:45.815Z', + deadline = '2021-03-16T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = COMPLETED, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignEndedCampaign.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..df380e689 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignEndedCampaign.md @@ -0,0 +1,53 @@ +--- +id: beta-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignEndedCampaign', 'BetaCampaignEndedCampaign'] +slug: /tools/sdk/python/beta/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'BetaCampaignEndedCampaign'] +--- + +# CampaignEndedCampaign + +Details about the certification campaign that ended. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID for the campaign. | [required] +**name** | **str** | The human friendly name of the campaign. | [required] +**description** | **str** | Extended description of the campaign. | [required] +**created** | **datetime** | The date and time the campaign was created. | [required] +**modified** | **datetime** | The date and time the campaign was last modified. | [optional] +**deadline** | **datetime** | The date and time the campaign is due. | [required] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign. | [required] +**campaign_owner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**status** | **Enum** [ 'COMPLETED' ] | The current status of the campaign. | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_ended_campaign import CampaignEndedCampaign + +campaign_ended_campaign = CampaignEndedCampaign( +id='2c91808576f886190176f88cac5a0010', +name='Manager Access Campaign', +description='Audit access for all employees.', +created='2021-02-16T03:04:45.815Z', +modified='2021-03-16T03:06:45.815Z', +deadline='2021-03-16T03:04:45.815Z', +type=MANAGER, +campaign_owner=sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), +status=COMPLETED +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignGenerated.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignGenerated.md new file mode 100644 index 000000000..3f317d32e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignGenerated.md @@ -0,0 +1,45 @@ +--- +id: beta-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignGenerated', 'BetaCampaignGenerated'] +slug: /tools/sdk/python/beta/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'BetaCampaignGenerated'] +--- + +# CampaignGenerated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_generated import CampaignGenerated + +campaign_generated = CampaignGenerated( +campaign=sailpoint.beta.models.campaign_generated_campaign.CampaignGenerated_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-02-17T03:04:45.815Z', + deadline = '2021-02-18T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.beta.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = STAGED, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..c37e58532 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,53 @@ +--- +id: beta-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignGeneratedCampaign', 'BetaCampaignGeneratedCampaign'] +slug: /tools/sdk/python/beta/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'BetaCampaignGeneratedCampaign'] +--- + +# CampaignGeneratedCampaign + +Details about the campaign that was generated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign. | [required] +**name** | **str** | Human friendly name of the campaign. | [required] +**description** | **str** | Extended description of the campaign. | [required] +**created** | **datetime** | The date and time the campaign was created. | [required] +**modified** | **str** | The date and time the campaign was last modified. | [optional] +**deadline** | **str** | The date and time when the campaign must be finished by. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign that was generated. | [required] +**campaign_owner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required] +**status** | **Enum** [ 'STAGED', 'ACTIVATING', 'ACTIVE' ] | The current status of the campaign. | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_generated_campaign import CampaignGeneratedCampaign + +campaign_generated_campaign = CampaignGeneratedCampaign( +id='2c91808576f886190176f88cac5a0010', +name='Manager Access Campaign', +description='Audit access for all employees.', +created='2021-02-16T03:04:45.815Z', +modified='2021-02-17T03:04:45.815Z', +deadline='2021-02-18T03:04:45.815Z', +type=MANAGER, +campaign_owner=sailpoint.beta.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), +status=STAGED +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..ef4c65c8b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'BetaCampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/python/beta/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'BetaCampaignGeneratedCampaignCampaignOwner'] +--- + +# CampaignGeneratedCampaignCampaignOwner + +The identity that owns the campaign. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity. | [required] +**display_name** | **str** | The display name of the identity. | [required] +**email** | **str** | The primary email address of the identity. | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_generated_campaign_campaign_owner import CampaignGeneratedCampaignCampaignOwner + +campaign_generated_campaign_campaign_owner = CampaignGeneratedCampaignCampaignOwner( +id='37f080867702c1910177031320c40n27', +display_name='John Snow', +email='john.snow@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignReference.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignReference.md new file mode 100644 index 000000000..6260e26a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignReference.md @@ -0,0 +1,45 @@ +--- +id: beta-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReference', 'BetaCampaignReference'] +slug: /tools/sdk/python/beta/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'BetaCampaignReference'] +--- + +# CampaignReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign. | [required] +**name** | **str** | The name of the campaign. | [required] +**type** | **Enum** [ 'CAMPAIGN' ] | The type of object that is being referenced. | [required] +**campaign_type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH' ] | The type of the campaign. | [required] +**description** | **str** | The description of the campaign set by the admin who created it. | [required] +**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). | [required] +**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. | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_reference import CampaignReference + +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignReport.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignReport.md new file mode 100644 index 000000000..9188fd67d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignReport.md @@ -0,0 +1,43 @@ +--- +id: beta-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReport', 'BetaCampaignReport'] +slug: /tools/sdk/python/beta/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'BetaCampaignReport'] +--- + +# CampaignReport + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +**status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR', 'PENDING' ] | Status of a SOD policy violation report. | [optional] +**report_type** | [**ReportType**](report-type) | | [required] +**last_run_at** | **datetime** | The most recent date and time this report was run | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.campaign_report import CampaignReport + +campaign_report = CampaignReport( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation', +status='PENDING', +report_type='CAMPAIGN_COMPOSITION_REPORT', +last_run_at=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignReportsConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..1a98a9c1d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignReportsConfig.md @@ -0,0 +1,33 @@ +--- +id: beta-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReportsConfig', 'BetaCampaignReportsConfig'] +slug: /tools/sdk/python/beta/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'BetaCampaignReportsConfig'] +--- + +# CampaignReportsConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attribute_columns** | **[]str** | list of identity attribute columns | [optional] +} + +## Example + +```python +from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig + +campaign_reports_config = CampaignReportsConfig( +identity_attribute_columns=[firstname, lastname] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignTemplate.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignTemplate.md new file mode 100644 index 000000000..2990f6eeb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignTemplate.md @@ -0,0 +1,54 @@ +--- +id: beta-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignTemplate', 'BetaCampaignTemplate'] +slug: /tools/sdk/python/beta/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'BetaCampaignTemplate'] +--- + +# CampaignTemplate + +Campaign Template + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign template | [optional] +**name** | **str** | This template's name. Has no bearing on generated campaigns' names. | [required] +**description** | **str** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] +**created** | **datetime** | Creation date of Campaign Template | [required][readonly] +**modified** | **datetime** | Modification date of Campaign Template | [required][readonly] +**scheduled** | **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to False] +**owner_ref** | [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**deadline_duration** | **str** | 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). | [optional] +**campaign** | [**Campaign**](campaign) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.campaign_template import CampaignTemplate + +campaign_template = CampaignTemplate( +id='2c9079b270a266a60170a277bb960008', +name='Manager Campaign Template', +description='Template for the annual manager campaign.', +created='2020-03-05T22:44:00.364Z', +modified='2020-03-05T22:52:09.969Z', +scheduled=False, +owner_ref=sailpoint.beta.models.campaign_template_owner_ref.CampaignTemplate_ownerRef( + id = '2c918086676d3e0601677611dbde220f', + type = 'IDENTITY', + name = 'Mister Manager', + email = 'mr.manager@example.com', ), +deadline_duration='P2W', +campaign=sailpoint.beta.models.campaign.Campaign() +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/python/Reference/Beta/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..31c691403 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,40 @@ +--- +id: beta-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignTemplateOwnerRef', 'BetaCampaignTemplateOwnerRef'] +slug: /tools/sdk/python/beta/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'BetaCampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the owner | [optional] +**type** | **Enum** [ 'IDENTITY' ] | Type of the owner | [optional] +**name** | **str** | Name of the owner | [optional] +**email** | **str** | Email of the owner | [optional] +} + +## Example + +```python +from sailpoint.beta.models.campaign_template_owner_ref import CampaignTemplateOwnerRef + +campaign_template_owner_ref = CampaignTemplateOwnerRef( +id='2c918086676d3e0601677611dbde220f', +type='IDENTITY', +name='Mister Manager', +email='mr.manager@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CancelAccessRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CancelAccessRequest.md new file mode 100644 index 000000000..03e820c34 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CancelAccessRequest.md @@ -0,0 +1,36 @@ +--- +id: beta-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelAccessRequest', 'BetaCancelAccessRequest'] +slug: /tools/sdk/python/beta/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'BetaCancelAccessRequest'] +--- + +# CancelAccessRequest + +Request body payload for cancel access request endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_activity_id** | **str** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] +**comment** | **str** | Reason for cancelling the pending access request. | [required] +} + +## Example + +```python +from sailpoint.beta.models.cancel_access_request import CancelAccessRequest + +cancel_access_request = CancelAccessRequest( +account_activity_id='2c9180835d2e5168015d32f890ca1581', +comment='I requested this role by mistake.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CancelableAccountActivity.md b/docs/tools/sdk/python/Reference/Beta/Models/CancelableAccountActivity.md new file mode 100644 index 000000000..0875364f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CancelableAccountActivity.md @@ -0,0 +1,112 @@ +--- +id: beta-cancelable-account-activity +title: CancelableAccountActivity +pagination_label: CancelableAccountActivity +sidebar_label: CancelableAccountActivity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelableAccountActivity', 'BetaCancelableAccountActivity'] +slug: /tools/sdk/python/beta/models/cancelable-account-activity +tags: ['SDK', 'Software Development Kit', 'CancelableAccountActivity', 'BetaCancelableAccountActivity'] +--- + +# CancelableAccountActivity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the account activity itself | [optional] +**name** | **str** | | [optional] +**created** | **datetime** | | [optional] +**modified** | **datetime** | | [optional] +**completed** | **datetime** | | [optional] +**completion_status** | [**CompletionStatus**](completion-status) | | [optional] +**type** | **str** | | [optional] +**requester_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**target_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**errors** | **[]str** | | [optional] +**warnings** | **[]str** | | [optional] +**items** | [**[]AccountActivityItem**](account-activity-item) | | [optional] +**execution_status** | [**ExecutionStatus**](execution-status) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +**cancelable** | **bool** | Whether the account activity can be canceled before completion | [optional] +**cancel_comment** | [**Comment**](comment) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity + +cancelable_account_activity = CancelableAccountActivity( +id='2c9180835d2e5168015d32f890ca1581', +name='2c9180835d2e5168015d32f890ca1581', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +completed='2018-10-19T13:49:37.385Z', +completion_status='SUCCESS', +type='appRequest', +requester_identity_summary=sailpoint.beta.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +target_identity_summary=sailpoint.beta.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +errors=[sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.], +warnings=[ + '' + ], +items=[ + sailpoint.beta.models.account_activity_item.AccountActivityItem( + id = '48c545831b264409a81befcabb0e3c5a', + name = '48c545831b264409a81befcabb0e3c5a', + requested = '2017-07-11T18:45:37.098Z', + approval_status = 'PENDING', + provisioning_status = 'PENDING', + requester_comment = sailpoint.beta.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), + reviewer_identity_summary = sailpoint.beta.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), + reviewer_comment = sailpoint.beta.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), + operation = 'ADD', + attribute = 'detectedRoles', + value = 'Treasury Analyst [AccessProfile-1529010191212]', + native_identity = 'Sandie.Camero', + source_id = '2c91808363ef85290164000587130c0c', + account_request_info = sailpoint.beta.models.account_request_info.AccountRequestInfo( + requested_object_id = '2c91808563ef85690164001c31140c0c', + requested_object_name = 'Treasury Analyst', + requested_object_type = 'ACCESS_PROFILE', ), + client_metadata = {customKey1=custom value 1, customKey2=custom value 2}, + remove_date = '2020-07-11T00:00Z', ) + ], +execution_status='COMPLETED', +client_metadata={ + 'key' : '' + }, +cancelable=True, +cancel_comment=sailpoint.beta.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CancelledRequestDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..12030fcbd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CancelledRequestDetails.md @@ -0,0 +1,41 @@ +--- +id: beta-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelledRequestDetails', 'BetaCancelledRequestDetails'] +slug: /tools/sdk/python/beta/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'BetaCancelledRequestDetails'] +--- + +# CancelledRequestDetails + +Provides additional details for a request that has been cancelled. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.cancelled_request_details import CancelledRequestDetails + +cancelled_request_details = CancelledRequestDetails( +comment='This request must be cancelled.', +owner=sailpoint.beta.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +modified='2019-12-20T09:17:12.192Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationDto.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationDto.md new file mode 100644 index 000000000..bbf95bf7e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationDto.md @@ -0,0 +1,70 @@ +--- +id: beta-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationDto', 'BetaCertificationDto'] +slug: /tools/sdk/python/beta/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'BetaCertificationDto'] +--- + +# CertificationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign_ref** | [**CampaignReference**](campaign-reference) | | [required] +**phase** | [**CertificationPhase**](certification-phase) | | [required] +**due** | **datetime** | The due date of the certification. | [required] +**signed** | **datetime** | The date the reviewer signed off on the certification. | [required] +**reviewer** | [**Reviewer**](reviewer) | | [required] +**reassignment** | [**Reassignment**](reassignment) | | [optional] +**has_errors** | **bool** | Indicates it the certification has any errors. | [required] +**error_message** | **str** | A message indicating what the error is. | [optional] +**completed** | **bool** | Indicates if all certification decisions have been made. | [required] +**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**entities_completed** | **int** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**entities_total** | **int** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] +} + +## Example + +```python +from sailpoint.beta.models.certification_dto import CertificationDto + +certification_dto = CertificationDto( +campaign_ref=sailpoint.beta.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', ), +phase='ACTIVE', +due='2018-10-19T13:49:37.385Z', +signed='2018-10-19T13:49:37.385Z', +reviewer=sailpoint.beta.models.reviewer.Reviewer( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', + email = 'reviewer@test.com', ), +reassignment=sailpoint.beta.models.reassignment.Reassignment( + from = sailpoint.beta.models.certification_reference.CertificationReference(), + comment = 'Please review', ), +has_errors=False, +error_message='The certification has an error', +completed=False, +decisions_made=20, +decisions_total=40, +entities_completed=5, +entities_total=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationPhase.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationPhase.md new file mode 100644 index 000000000..36813ebf6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationPhase.md @@ -0,0 +1,25 @@ +--- +id: beta-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationPhase', 'BetaCertificationPhase'] +slug: /tools/sdk/python/beta/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'BetaCertificationPhase'] +--- + +# CertificationPhase + +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` (value: `'STAGED'`) + +* `ACTIVE` (value: `'ACTIVE'`) + +* `SIGNED` (value: `'SIGNED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationReference.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationReference.md new file mode 100644 index 000000000..bdd6d9f74 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationReference.md @@ -0,0 +1,44 @@ +--- +id: beta-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationReference', 'BetaCertificationReference'] +slug: /tools/sdk/python/beta/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'BetaCertificationReference'] +--- + +# CertificationReference + +Previous certification. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CERTIFICATION' ] | DTO type of certification for review. | [optional] +**id** | **str** | ID of certification for review. | [optional] +**name** | **str** | Display name of certification for review. | [optional] +**reviewer** | [**Reviewer**](reviewer) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.certification_reference import CertificationReference + +certification_reference = CertificationReference( +type='IDENTITY', +id='7589a83cec4b4f138ce56c1a5ef0756d', +name='Manager Access for Michael Michaels', +reviewer=sailpoint.beta.models.reviewer.Reviewer( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', + email = 'reviewer@test.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationReferenceDto.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationReferenceDto.md new file mode 100644 index 000000000..e9ad01a22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationReferenceDto.md @@ -0,0 +1,38 @@ +--- +id: beta-certification-reference-dto +title: CertificationReferenceDto +pagination_label: CertificationReferenceDto +sidebar_label: CertificationReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationReferenceDto', 'BetaCertificationReferenceDto'] +slug: /tools/sdk/python/beta/models/certification-reference-dto +tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'BetaCertificationReferenceDto'] +--- + +# CertificationReferenceDto + +Certification for review. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CERTIFICATION' ] | DTO type of certification for review. | [optional] +**id** | **str** | ID of certification for review. | [optional] +**name** | **str** | Display name of certification for review. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.certification_reference_dto import CertificationReferenceDto + +certification_reference_dto = CertificationReferenceDto( +type='IDENTITY', +id='7589a83cec4b4f138ce56c1a5ef0756d', +name='Manager Access for Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOff.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOff.md new file mode 100644 index 000000000..a99c545f3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOff.md @@ -0,0 +1,37 @@ +--- +id: beta-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationSignedOff', 'BetaCertificationSignedOff'] +slug: /tools/sdk/python/beta/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'BetaCertificationSignedOff'] +--- + +# CertificationSignedOff + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.certification_signed_off import CertificationSignedOff + +certification_signed_off = CertificationSignedOff( +certification=sailpoint.beta.models.certification_signed_off_certification.CertificationSignedOff_certification( + id = '2c91808576f886190176f88caf0d0067', + name = 'Manager Access Review for Alice Baker', + created = '2020-02-16T03:04:45.815Z', + modified = '2020-02-16T03:06:45.815Z', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..7ac6ab464 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOffCertification.md @@ -0,0 +1,79 @@ +--- +id: beta-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationSignedOffCertification', 'BetaCertificationSignedOffCertification'] +slug: /tools/sdk/python/beta/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'BetaCertificationSignedOffCertification'] +--- + +# CertificationSignedOffCertification + +The certification campaign that was signed off on. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID of the certification. | [required] +**name** | **str** | The name of the certification. | [required] +**created** | **datetime** | The date and time the certification was created. | [required] +**modified** | **datetime** | The date and time the certification was last modified. | [optional] +**campaign_ref** | [**CampaignReference**](campaign-reference) | | [required] +**phase** | [**CertificationPhase**](certification-phase) | | [required] +**due** | **datetime** | The due date of the certification. | [required] +**signed** | **datetime** | The date the reviewer signed off on the certification. | [required] +**reviewer** | [**Reviewer**](reviewer) | | [required] +**reassignment** | [**Reassignment**](reassignment) | | [optional] +**has_errors** | **bool** | Indicates it the certification has any errors. | [required] +**error_message** | **str** | A message indicating what the error is. | [optional] +**completed** | **bool** | Indicates if all certification decisions have been made. | [required] +**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**entities_completed** | **int** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**entities_total** | **int** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] +} + +## Example + +```python +from sailpoint.beta.models.certification_signed_off_certification import CertificationSignedOffCertification + +certification_signed_off_certification = CertificationSignedOffCertification( +id='2c91808576f886190176f88caf0d0067', +name='Manager Access Review for Alice Baker', +created='2020-02-16T03:04:45.815Z', +modified='2020-02-16T03:06:45.815Z', +campaign_ref=sailpoint.beta.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', ), +phase='ACTIVE', +due='2018-10-19T13:49:37.385Z', +signed='2018-10-19T13:49:37.385Z', +reviewer=sailpoint.beta.models.reviewer.Reviewer( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', + email = 'reviewer@test.com', ), +reassignment=sailpoint.beta.models.reassignment.Reassignment( + from = sailpoint.beta.models.certification_reference.CertificationReference(), + comment = 'Please review', ), +has_errors=False, +error_message='The certification has an error', +completed=False, +decisions_made=20, +decisions_total=40, +entities_completed=5, +entities_total=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertificationTask.md b/docs/tools/sdk/python/Reference/Beta/Models/CertificationTask.md new file mode 100644 index 000000000..9fcd6afd7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertificationTask.md @@ -0,0 +1,50 @@ +--- +id: beta-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationTask', 'BetaCertificationTask'] +slug: /tools/sdk/python/beta/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'BetaCertificationTask'] +--- + +# CertificationTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification task. | [optional] +**type** | **Enum** [ 'REASSIGN', 'ADMIN_REASSIGN', 'COMPLETE_CERTIFICATION', 'FINISH_CERTIFICATION', 'COMPLETE_CAMPAIGN', 'ACTIVATE_CAMPAIGN', 'CAMPAIGN_CREATE', 'CAMPAIGN_DELETE' ] | The type of the certification task. More values may be added in the future. | [optional] +**target_type** | **Enum** [ 'CERTIFICATION', 'CAMPAIGN' ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**target_id** | **str** | The ID of the item being operated on by this task. | [optional] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The status of the task. | [optional] +**errors** | [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**created** | **datetime** | The date and time on which this task was created. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.certification_task import CertificationTask + +certification_task = CertificationTask( +id='2c918086719eec070171a7e3355a360a', +type='ADMIN_REASSIGN', +target_type='CAMPAIGN', +target_id='2c918086719eec070171a7e3355a834c', +status='QUEUED', +errors=[ + sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], +created='2020-09-24T18:10:47.693Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CertifierResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/CertifierResponse.md new file mode 100644 index 000000000..3a3c61832 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CertifierResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertifierResponse', 'BetaCertifierResponse'] +slug: /tools/sdk/python/beta/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'BetaCertifierResponse'] +--- + +# CertifierResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of the certifier | [optional] +**display_name** | **str** | the name of the certifier | [optional] +} + +## Example + +```python +from sailpoint.beta.models.certifier_response import CertifierResponse + +certifier_response = CertifierResponse( +id='8a80828f643d484f01643e14202e206f', +display_name='John Snow' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Children.md b/docs/tools/sdk/python/Reference/Beta/Models/Children.md new file mode 100644 index 000000000..0981d641c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Children.md @@ -0,0 +1,40 @@ +--- +id: beta-children +title: Children +pagination_label: Children +sidebar_label: Children +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Children', 'BetaChildren'] +slug: /tools/sdk/python/beta/models/children +tags: ['SDK', 'Software Development Kit', 'Children', 'BetaChildren'] +--- + +# Children + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **str** | | [optional] +**attribute** | **str** | | [optional] +**value** | [**Value**](value) | | [optional] +**children** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.children import Children + +children = Children( +operator='EQUALS', +attribute='country', +value=sailpoint.beta.models.value.Value( + type = 'STRING', ), +children='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ClientLogConfiguration.md b/docs/tools/sdk/python/Reference/Beta/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..78f05e166 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ClientLogConfiguration.md @@ -0,0 +1,42 @@ +--- +id: beta-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfiguration', 'BetaClientLogConfiguration'] +slug: /tools/sdk/python/beta/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'BetaClientLogConfiguration'] +--- + +# ClientLogConfiguration + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults | [required] +**expiration** | **datetime** | Expiration date-time of the log configuration request | [optional] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration + +client_log_configuration = ClientLogConfiguration( +client_id='aClientId', +duration_minutes=120, +expiration='2020-12-15T19:13:36.079Z', +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ClientType.md b/docs/tools/sdk/python/Reference/Beta/Models/ClientType.md new file mode 100644 index 000000000..2942413f9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ClientType.md @@ -0,0 +1,23 @@ +--- +id: beta-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientType', 'BetaClientType'] +slug: /tools/sdk/python/beta/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'BetaClientType'] +--- + +# ClientType + +Type of an API Client indicating public or confidentials use + +## Enum + +* `CONFIDENTIAL` (value: `'CONFIDENTIAL'`) + +* `PUBLIC` (value: `'PUBLIC'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CloseAccessRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CloseAccessRequest.md new file mode 100644 index 000000000..df0e8ac38 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CloseAccessRequest.md @@ -0,0 +1,40 @@ +--- +id: beta-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CloseAccessRequest', 'BetaCloseAccessRequest'] +slug: /tools/sdk/python/beta/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'BetaCloseAccessRequest'] +--- + +# CloseAccessRequest + +Request body payload for close access requests endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_ids** | **[]str** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [required] +**message** | **str** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to 'The IdentityNow Administrator manually closed this request.'] +**execution_status** | **Enum** [ 'Terminated', 'Completed' ] | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to 'Terminated'] +**completion_status** | **Enum** [ 'Success', 'Incomplete', 'Failure' ] | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to 'Failure'] +} + +## Example + +```python +from sailpoint.beta.models.close_access_request import CloseAccessRequest + +close_access_request = CloseAccessRequest( +access_request_ids=[2c90ad2a70ace7d50170acf22ca90010], +message='The IdentityNow Administrator manually closed this request.', +execution_status='Terminated', +completion_status='Failure' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Comment.md b/docs/tools/sdk/python/Reference/Beta/Models/Comment.md new file mode 100644 index 000000000..082054853 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Comment.md @@ -0,0 +1,39 @@ +--- +id: beta-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Comment', 'BetaComment'] +slug: /tools/sdk/python/beta/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'BetaComment'] +--- + +# Comment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commenter_id** | **str** | Id of the identity making the comment | [optional] +**commenter_name** | **str** | Human-readable display name of the identity making the comment | [optional] +**body** | **str** | Content of the comment | [optional] +**var_date** | **datetime** | Date and time comment was made | [optional] +} + +## Example + +```python +from sailpoint.beta.models.comment import Comment + +comment = Comment( +commenter_id='2c918084660f45d6016617daa9210584', +commenter_name='Adam Kennedy', +body='Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', +var_date='2017-07-11T18:45:37.098Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommentDto.md b/docs/tools/sdk/python/Reference/Beta/Models/CommentDto.md new file mode 100644 index 000000000..bb2d49bfb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommentDto.md @@ -0,0 +1,40 @@ +--- +id: beta-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDto', 'BetaCommentDto'] +slug: /tools/sdk/python/beta/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'BetaCommentDto'] +--- + +# CommentDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.comment_dto import CommentDto + +comment_dto = CommentDto( +comment='This is a comment.', +author=sailpoint.beta.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Adam Kennedy', ), +created='2017-07-11T18:45:37.098Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommentDto1.md b/docs/tools/sdk/python/Reference/Beta/Models/CommentDto1.md new file mode 100644 index 000000000..1ea620f1a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommentDto1.md @@ -0,0 +1,40 @@ +--- +id: beta-comment-dto1 +title: CommentDto1 +pagination_label: CommentDto1 +sidebar_label: CommentDto1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDto1', 'BetaCommentDto1'] +slug: /tools/sdk/python/beta/models/comment-dto1 +tags: ['SDK', 'Software Development Kit', 'CommentDto1', 'BetaCommentDto1'] +--- + +# CommentDto1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDto1Author**](comment-dto1-author) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.comment_dto1 import CommentDto1 + +comment_dto1 = CommentDto1( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.beta.models.comment_dto_1_author.CommentDto_1_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommentDto1Author.md b/docs/tools/sdk/python/Reference/Beta/Models/CommentDto1Author.md new file mode 100644 index 000000000..0ec261597 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommentDto1Author.md @@ -0,0 +1,38 @@ +--- +id: beta-comment-dto1-author +title: CommentDto1Author +pagination_label: CommentDto1Author +sidebar_label: CommentDto1Author +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDto1Author', 'BetaCommentDto1Author'] +slug: /tools/sdk/python/beta/models/comment-dto1-author +tags: ['SDK', 'Software Development Kit', 'CommentDto1Author', 'BetaCommentDto1Author'] +--- + +# CommentDto1Author + +Author of the comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional] +**id** | **str** | The unique ID of the object | [optional] +**name** | **str** | The display name of the object | [optional] +} + +## Example + +```python +from sailpoint.beta.models.comment_dto1_author import CommentDto1Author + +comment_dto1_author = CommentDto1Author( +type='IDENTITY', +id='2c9180847e25f377017e2ae8cae4650b', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommentDtoAuthor.md b/docs/tools/sdk/python/Reference/Beta/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..74b258100 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommentDtoAuthor.md @@ -0,0 +1,37 @@ +--- +id: beta-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDtoAuthor', 'BetaCommentDtoAuthor'] +slug: /tools/sdk/python/beta/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'BetaCommentDtoAuthor'] +--- + +# CommentDtoAuthor + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the commenting identity. | [optional] +**id** | **str** | ID of the commenting identity. | [optional] +**name** | **str** | Display name of the commenting identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.comment_dto_author import CommentDtoAuthor + +comment_dto_author = CommentDtoAuthor( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='Adam Kennedy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessIDStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..6d245993c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessIDStatus.md @@ -0,0 +1,39 @@ +--- +id: beta-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessIDStatus', 'BetaCommonAccessIDStatus'] +slug: /tools/sdk/python/beta/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'BetaCommonAccessIDStatus'] +--- + +# CommonAccessIDStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**confirmed_ids** | **[]str** | List of confirmed common access ids. | [optional] +**denied_ids** | **[]str** | List of denied common access ids. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.common_access_id_status import CommonAccessIDStatus + +common_access_id_status = CommonAccessIDStatus( +confirmed_ids=[ + '' + ], +denied_ids=[ + '' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemAccess.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..9036dcbcb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemAccess.md @@ -0,0 +1,43 @@ +--- +id: beta-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemAccess', 'BetaCommonAccessItemAccess'] +slug: /tools/sdk/python/beta/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'BetaCommonAccessItemAccess'] +--- + +# CommonAccessItemAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Common access ID | [optional] +**type** | [**CommonAccessType**](common-access-type) | | [optional] +**name** | **str** | Common access name | [optional] +**description** | **str** | Common access description | [optional] +**owner_name** | **str** | Common access owner name | [optional] +**owner_id** | **str** | Common access owner ID | [optional] +} + +## Example + +```python +from sailpoint.beta.models.common_access_item_access import CommonAccessItemAccess + +common_access_item_access = CommonAccessItemAccess( +id='', +type='ACCESS_PROFILE', +name='', +description='', +owner_name='', +owner_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..e46c73255 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemRequest.md @@ -0,0 +1,41 @@ +--- +id: beta-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemRequest', 'BetaCommonAccessItemRequest'] +slug: /tools/sdk/python/beta/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'BetaCommonAccessItemRequest'] +--- + +# CommonAccessItemRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**status** | [**CommonAccessItemState**](common-access-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.common_access_item_request import CommonAccessItemRequest + +common_access_item_request = CommonAccessItemRequest( +access=sailpoint.beta.models.common_access_item_access.CommonAccessItemAccess( + id = '', + type = 'ACCESS_PROFILE', + name = '', + description = '', + owner_name = '', + owner_id = '', ), +status='CONFIRMED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..17709d275 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemResponse.md @@ -0,0 +1,51 @@ +--- +id: beta-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemResponse', 'BetaCommonAccessItemResponse'] +slug: /tools/sdk/python/beta/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'BetaCommonAccessItemResponse'] +--- + +# CommonAccessItemResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Common Access Item ID | [optional] +**access** | [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**status** | [**CommonAccessItemState**](common-access-item-state) | | [optional] +**last_updated** | **str** | | [optional] +**reviewed_by_user** | **bool** | | [optional] +**last_reviewed** | **str** | | [optional] +**created_by_user** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.common_access_item_response import CommonAccessItemResponse + +common_access_item_response = CommonAccessItemResponse( +id='', +access=sailpoint.beta.models.common_access_item_access.CommonAccessItemAccess( + id = '', + type = 'ACCESS_PROFILE', + name = '', + description = '', + owner_name = '', + owner_id = '', ), +status='CONFIRMED', +last_updated='', +reviewed_by_user=True, +last_reviewed='', +created_by_user='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemState.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemState.md new file mode 100644 index 000000000..28802aeec --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessItemState.md @@ -0,0 +1,23 @@ +--- +id: beta-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemState', 'BetaCommonAccessItemState'] +slug: /tools/sdk/python/beta/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'BetaCommonAccessItemState'] +--- + +# CommonAccessItemState + +State of common access item. + +## Enum + +* `CONFIRMED` (value: `'CONFIRMED'`) + +* `DENIED` (value: `'DENIED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessResponse.md new file mode 100644 index 000000000..60ddd692e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessResponse.md @@ -0,0 +1,53 @@ +--- +id: beta-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessResponse', 'BetaCommonAccessResponse'] +slug: /tools/sdk/python/beta/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'BetaCommonAccessResponse'] +--- + +# CommonAccessResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID of the common access item | [optional] +**access** | [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**status** | **str** | CONFIRMED or DENIED | [optional] +**common_access_type** | **str** | | [optional] +**last_updated** | **datetime** | | [optional] [readonly] +**reviewed_by_user** | **bool** | true if user has confirmed or denied status | [optional] +**last_reviewed** | **datetime** | | [optional] [readonly] +**created_by_user** | **bool** | | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.common_access_response import CommonAccessResponse + +common_access_response = CommonAccessResponse( +id='555ab47a-0d32-4813-906f-adf3567de6a4', +access=sailpoint.beta.models.common_access_item_access.CommonAccessItemAccess( + id = '', + type = 'ACCESS_PROFILE', + name = '', + description = '', + owner_name = '', + owner_id = '', ), +status='', +common_access_type='UNSET', +last_updated=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +reviewed_by_user=True, +last_reviewed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +created_by_user=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessType.md b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessType.md new file mode 100644 index 000000000..ea8f29913 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CommonAccessType.md @@ -0,0 +1,23 @@ +--- +id: beta-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessType', 'BetaCommonAccessType'] +slug: /tools/sdk/python/beta/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'BetaCommonAccessType'] +--- + +# CommonAccessType + +The type of access item. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompleteCampaignOptions.md b/docs/tools/sdk/python/Reference/Beta/Models/CompleteCampaignOptions.md new file mode 100644 index 000000000..dd3af8b3d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompleteCampaignOptions.md @@ -0,0 +1,33 @@ +--- +id: beta-complete-campaign-options +title: CompleteCampaignOptions +pagination_label: CompleteCampaignOptions +sidebar_label: CompleteCampaignOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompleteCampaignOptions', 'BetaCompleteCampaignOptions'] +slug: /tools/sdk/python/beta/models/complete-campaign-options +tags: ['SDK', 'Software Development Kit', 'CompleteCampaignOptions', 'BetaCompleteCampaignOptions'] +--- + +# CompleteCampaignOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto_complete_action** | **Enum** [ 'APPROVE', 'REVOKE' ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to 'APPROVE'] +} + +## Example + +```python +from sailpoint.beta.models.complete_campaign_options import CompleteCampaignOptions + +complete_campaign_options = CompleteCampaignOptions( +auto_complete_action='APPROVE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompleteInvocation.md b/docs/tools/sdk/python/Reference/Beta/Models/CompleteInvocation.md new file mode 100644 index 000000000..5d7709698 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompleteInvocation.md @@ -0,0 +1,37 @@ +--- +id: beta-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompleteInvocation', 'BetaCompleteInvocation'] +slug: /tools/sdk/python/beta/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'BetaCompleteInvocation'] +--- + +# CompleteInvocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**secret** | **str** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | [required] +**error** | **str** | The error message to indicate a failed invocation or error if any. | [optional] +**output** | **object** | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | [required] +} + +## Example + +```python +from sailpoint.beta.models.complete_invocation import CompleteInvocation + +complete_invocation = CompleteInvocation( +secret='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +error='Access request is denied.', +output={approved=false} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompleteInvocationInput.md b/docs/tools/sdk/python/Reference/Beta/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..e33a371b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompleteInvocationInput.md @@ -0,0 +1,37 @@ +--- +id: beta-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompleteInvocationInput', 'BetaCompleteInvocationInput'] +slug: /tools/sdk/python/beta/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'BetaCompleteInvocationInput'] +--- + +# CompleteInvocationInput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**localized_error** | [**LocalizedMessage**](localized-message) | | [optional] +**output** | **object** | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.complete_invocation_input import CompleteInvocationInput + +complete_invocation_input = CompleteInvocationInput( +localized_error=sailpoint.beta.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), +output={approved=false} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompletedApproval.md b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApproval.md new file mode 100644 index 000000000..8731578dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApproval.md @@ -0,0 +1,155 @@ +--- +id: beta-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApproval', 'BetaCompletedApproval'] +slug: /tools/sdk/python/beta/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'BetaCompletedApproval'] +--- + +# CompletedApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval id. | [optional] +**name** | **str** | The name of the approval. | [optional] +**created** | **datetime** | When the approval was created. | [optional] +**modified** | **datetime** | When the approval was modified last time. | [optional] +**request_created** | **datetime** | When the access-request was created. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requester** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**reviewed_by** | [**CompletedApprovalReviewedBy**](completed-approval-reviewed-by) | | [optional] +**owner** | [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] +**requested_object** | [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**requester_comment** | [**CommentDto1**](comment-dto1) | | [optional] +**reviewer_comment** | [**CommentDto**](comment-dto) | The approval's reviewer's comment. | [optional] +**previous_reviewers_comments** | [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**comment_required_when_rejected** | **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to False] +**state** | [**CompletedApprovalState**](completed-approval-state) | | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**remove_date_update_requested** | **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to False] +**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**sod_violation_context** | [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] +**pre_approval_trigger_result** | [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs provided during the request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.completed_approval import CompletedApproval + +completed_approval = CompletedApproval( +id='2c938083633d259901633d25c68c00fa', +name='Approval Name', +created='2017-07-11T18:45:37.098Z', +modified='2018-07-25T20:22:28.104Z', +request_created='2017-07-11T18:45:35.098Z', +request_type='GRANT_ACCESS', +requester=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.beta.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +reviewed_by=sailpoint.beta.models.completed_approval_reviewed_by.CompletedApproval_reviewedBy( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +owner=sailpoint.beta.models.access_item_owner_dto.AccessItemOwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +requested_object=sailpoint.beta.models.requestable_object_reference.RequestableObjectReference( + id = '2c938083633d259901633d25c68c00fa', + name = 'Object Name', + description = 'Object Description', + type = 'ROLE', ), +requester_comment=sailpoint.beta.models.comment_dto_1.CommentDto_1( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.beta.models.comment_dto_1_author.CommentDto_1_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ), +reviewer_comment=sailpoint.beta.models.comment_dto.CommentDto( + comment = 'This is a comment.', + author = sailpoint.beta.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Adam Kennedy', ), + created = '2017-07-11T18:45:37.098Z', ), +previous_reviewers_comments=[ + sailpoint.beta.models.comment_dto_1.CommentDto_1( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.beta.models.comment_dto_1_author.CommentDto_1_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ) + ], +forward_history=[ + sailpoint.beta.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], +comment_required_when_rejected=True, +state='APPROVED', +remove_date='2020-07-11T00:00Z', +remove_date_update_requested=True, +current_remove_date='2020-07-11T00:00Z', +sod_violation_context=sailpoint.beta.models.sod_violation_context_check_completed_1.SodViolationContextCheckCompleted_1( + state = 'SUCCESS', + uuid = 'f73d16e9-a038-46c5-b217-1246e15fdbdd', + violation_check_result = sailpoint.beta.models.sod_violation_check_result_1.SodViolationCheckResult_1( + message = sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.beta.models.sod_violation_context_1.SodViolationContext_1( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ), ), +pre_approval_trigger_result=sailpoint.beta.models.completed_approval_pre_approval_trigger_result.CompletedApproval_preApprovalTriggerResult( + comment = 'This request was autoapproved by our automated ETS subscriber', + decision = 'APPROVED', + reviewer = 'Automated AR Approval', + date = '2022-06-07T19:18:40.748Z', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..72a588780 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,40 @@ +--- +id: beta-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'BetaCompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/python/beta/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'BetaCompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | The comment from the trigger | [optional] +**decision** | [**CompletedApprovalState**](completed-approval-state) | | [optional] +**reviewer** | **str** | The name of the approver | [optional] +**var_date** | **datetime** | The date and time the trigger decided on the request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.completed_approval_pre_approval_trigger_result import CompletedApprovalPreApprovalTriggerResult + +completed_approval_pre_approval_trigger_result = CompletedApprovalPreApprovalTriggerResult( +comment='This request was autoapproved by our automated ETS subscriber', +decision='APPROVED', +reviewer='Automated AR Approval', +var_date='2022-06-07T19:18:40.748Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalReviewedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalReviewedBy.md new file mode 100644 index 000000000..ca3afe59e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalReviewedBy.md @@ -0,0 +1,38 @@ +--- +id: beta-completed-approval-reviewed-by +title: CompletedApprovalReviewedBy +pagination_label: CompletedApprovalReviewedBy +sidebar_label: CompletedApprovalReviewedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalReviewedBy', 'BetaCompletedApprovalReviewedBy'] +slug: /tools/sdk/python/beta/models/completed-approval-reviewed-by +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewedBy', 'BetaCompletedApprovalReviewedBy'] +--- + +# CompletedApprovalReviewedBy + +Identity who reviewed the access item request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.completed_approval_reviewed_by import CompletedApprovalReviewedBy + +completed_approval_reviewed_by = CompletedApprovalReviewedBy( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalState.md b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalState.md new file mode 100644 index 000000000..935e5aa52 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompletedApprovalState.md @@ -0,0 +1,23 @@ +--- +id: beta-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalState', 'BetaCompletedApprovalState'] +slug: /tools/sdk/python/beta/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'BetaCompletedApprovalState'] +--- + +# CompletedApprovalState + +Enum represents completed approval object's state. + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CompletionStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/CompletionStatus.md new file mode 100644 index 000000000..91fd9e649 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CompletionStatus.md @@ -0,0 +1,27 @@ +--- +id: beta-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletionStatus', 'BetaCompletionStatus'] +slug: /tools/sdk/python/beta/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'BetaCompletionStatus'] +--- + +# CompletionStatus + +The status after completion. + +## Enum + +* `SUCCESS` (value: `'SUCCESS'`) + +* `FAILURE` (value: `'FAILURE'`) + +* `INCOMPLETE` (value: `'INCOMPLETE'`) + +* `PENDING` (value: `'PENDING'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConditionEffect.md b/docs/tools/sdk/python/Reference/Beta/Models/ConditionEffect.md new file mode 100644 index 000000000..f2f50c47b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConditionEffect.md @@ -0,0 +1,38 @@ +--- +id: beta-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConditionEffect', 'BetaConditionEffect'] +slug: /tools/sdk/python/beta/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'BetaConditionEffect'] +--- + +# ConditionEffect + +Effect produced by a condition. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**effect_type** | **Enum** [ 'HIDE', 'SHOW', 'DISABLE', 'ENABLE', 'REQUIRE', 'OPTIONAL', 'SUBMIT_MESSAGE', 'SUBMIT_NOTIFICATION', 'SET_DEFAULT_VALUE' ] | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**config** | [**ConditionEffectConfig**](condition-effect-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.condition_effect import ConditionEffect + +condition_effect = ConditionEffect( +effect_type='HIDE', +config=sailpoint.beta.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/Beta/Models/ConditionEffectConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..616c89bdb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConditionEffectConfig.md @@ -0,0 +1,36 @@ +--- +id: beta-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConditionEffectConfig', 'BetaConditionEffectConfig'] +slug: /tools/sdk/python/beta/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'BetaConditionEffectConfig'] +--- + +# ConditionEffectConfig + +Arbitrary map containing a configuration based on the EffectType. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default_value_label** | **str** | Effect type's label. | [optional] +**element** | **str** | Element's identifier. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.condition_effect_config import ConditionEffectConfig + +condition_effect_config = ConditionEffectConfig( +default_value_label='Access to Remove', +element='8110662963316867' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConditionRule.md b/docs/tools/sdk/python/Reference/Beta/Models/ConditionRule.md new file mode 100644 index 000000000..3679203b3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConditionRule.md @@ -0,0 +1,41 @@ +--- +id: beta-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConditionRule', 'BetaConditionRule'] +slug: /tools/sdk/python/beta/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'BetaConditionRule'] +--- + +# ConditionRule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_type** | **Enum** [ 'INPUT', 'ELEMENT' ] | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**source** | **str** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**operator** | **Enum** [ 'EQ', 'NE', 'CO', 'NOT_CO', 'IN', 'NOT_IN', 'EM', 'NOT_EM', 'SW', 'NOT_SW', 'EW', 'NOT_EW' ] | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**value_type** | **Enum** [ 'STRING', 'STRING_LIST', 'INPUT', 'ELEMENT', 'LIST', 'BOOLEAN' ] | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**value** | **str** | Based on the ValueType. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.condition_rule import ConditionRule + +condition_rule = ConditionRule( +source_type='ELEMENT', +source='department', +operator='EQ', +value_type='STRING', +value='Engineering' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigObject.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigObject.md new file mode 100644 index 000000000..77d17ec45 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigObject.md @@ -0,0 +1,41 @@ +--- +id: beta-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigObject', 'BetaConfigObject'] +slug: /tools/sdk/python/beta/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'BetaConfigObject'] +--- + +# ConfigObject + +Config export and import format for individual object configurations. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Current version of configuration object. | [optional] +**var_self** | [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**object** | **map[string]object** | Object details. Format dependant on the object type. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.config_object import ConfigObject + +config_object = ConfigObject( +version=1, +var_self=sailpoint.beta.models.self_import_export_dto.SelfImportExportDto( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +object={ } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigType.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigType.md new file mode 100644 index 000000000..9ff4019ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigType.md @@ -0,0 +1,42 @@ +--- +id: beta-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigType', 'BetaConfigType'] +slug: /tools/sdk/python/beta/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'BetaConfigType'] +--- + +# ConfigType + +Type of Reassignment Configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**priority** | **int** | | [optional] +**internal_name** | [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**internal_name_camel** | [**ConfigTypeEnum**](config-type-enum) | | [optional] +**display_name** | **str** | Human readable display name of the type to be shown on UI | [optional] +**description** | **str** | Description of the type of work to be reassigned, displayed by the UI. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.config_type import ConfigType + +config_type = ConfigType( +priority=1, +internal_name='accessRequests', +internal_name_camel='ACCESS_REQUESTS', +display_name='Access Requests', +description='Reassign Access Request Work Items for an identity' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigTypeEnum.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..793c3bce0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigTypeEnum.md @@ -0,0 +1,25 @@ +--- +id: beta-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigTypeEnum', 'BetaConfigTypeEnum'] +slug: /tools/sdk/python/beta/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'BetaConfigTypeEnum'] +--- + +# ConfigTypeEnum + +Enum list of valid work types that can be selected for a Reassignment Configuration + +## Enum + +* `ACCESS_REQUESTS` (value: `'ACCESS_REQUESTS'`) + +* `CERTIFICATIONS` (value: `'CERTIFICATIONS'`) + +* `MANUAL_TASKS` (value: `'MANUAL_TASKS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..7beb8748a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,25 @@ +--- +id: beta-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigTypeEnumCamel', 'BetaConfigTypeEnumCamel'] +slug: /tools/sdk/python/beta/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'BetaConfigTypeEnumCamel'] +--- + +# ConfigTypeEnumCamel + +Enum list of valid work types that can be selected for a Reassignment Configuration + +## Enum + +* `ACCESSREQUESTS` (value: `'accessRequests'`) + +* `CERTIFICATIONS` (value: `'certifications'`) + +* `MANUALTASKS` (value: `'manualTasks'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..4468774cf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,52 @@ +--- +id: beta-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationDetailsResponse', 'BetaConfigurationDetailsResponse'] +slug: /tools/sdk/python/beta/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'BetaConfigurationDetailsResponse'] +--- + +# ConfigurationDetailsResponse + +The request body of Reassignment Configuration Details for a specific identity and config type + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config_type** | [**ConfigTypeEnum**](config-type-enum) | | [optional] +**target_identity** | [**Identity1**](identity1) | | [optional] +**start_date** | **datetime** | The date from which to start reassigning work items | [optional] +**end_date** | **datetime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**audit_details** | [**AuditDetails**](audit-details) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.configuration_details_response import ConfigurationDetailsResponse + +configuration_details_response = ConfigurationDetailsResponse( +config_type='ACCESS_REQUESTS', +target_identity=sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +start_date='2022-07-21T11:13:12.345Z', +end_date='0001-01-01T00:00Z', +audit_details=sailpoint.beta.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationItemRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..3cd703029 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationItemRequest.md @@ -0,0 +1,42 @@ +--- +id: beta-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationItemRequest', 'BetaConfigurationItemRequest'] +slug: /tools/sdk/python/beta/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'BetaConfigurationItemRequest'] +--- + +# ConfigurationItemRequest + +The request body for creation or update of a Reassignment Configuration for a single identity and work type + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassigned_from_id** | **str** | The identity id to reassign an item from | [optional] +**reassigned_to_id** | **str** | The identity id to reassign an item to | [optional] +**config_type** | [**ConfigTypeEnum**](config-type-enum) | | [optional] +**start_date** | **datetime** | The date from which to start reassigning work items | [optional] +**end_date** | **datetime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest + +configuration_item_request = ConfigurationItemRequest( +reassigned_from_id='2c91808781a71ddb0181b9090b5c504e', +reassigned_to_id='2c91808781a71ddb0181b9090b53504a', +config_type='ACCESS_REQUESTS', +start_date='2022-07-21T11:13:12.345Z', +end_date='2022-07-30T17:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationItemResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..6d3e9f5f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationItemResponse.md @@ -0,0 +1,53 @@ +--- +id: beta-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationItemResponse', 'BetaConfigurationItemResponse'] +slug: /tools/sdk/python/beta/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'BetaConfigurationItemResponse'] +--- + +# ConfigurationItemResponse + +The response body of a Reassignment Configuration for a single identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**Identity1**](identity1) | | [optional] +**config_details** | [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] +} + +## Example + +```python +from sailpoint.beta.models.configuration_item_response import ConfigurationItemResponse + +configuration_item_response = ConfigurationItemResponse( +identity=sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +config_details=[ + sailpoint.beta.models.configuration_details_response.ConfigurationDetailsResponse( + config_type = 'ACCESS_REQUESTS', + target_identity = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + start_date = '2022-07-21T11:13:12.345Z', + end_date = '0001-01-01T00:00Z', + audit_details = sailpoint.beta.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = , ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationResponse.md new file mode 100644 index 000000000..c4dcd95b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConfigurationResponse.md @@ -0,0 +1,53 @@ +--- +id: beta-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationResponse', 'BetaConfigurationResponse'] +slug: /tools/sdk/python/beta/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'BetaConfigurationResponse'] +--- + +# ConfigurationResponse + +The response body of a Reassignment Configuration for a single identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**Identity1**](identity1) | | [optional] +**config_details** | [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] +} + +## Example + +```python +from sailpoint.beta.models.configuration_response import ConfigurationResponse + +configuration_response = ConfigurationResponse( +identity=sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +config_details=[ + sailpoint.beta.models.configuration_details_response.ConfigurationDetailsResponse( + config_type = 'ACCESS_REQUESTS', + target_identity = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + start_date = '2022-07-21T11:13:12.345Z', + end_date = '0001-01-01T00:00Z', + audit_details = sailpoint.beta.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = , ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..a6222945f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: beta-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConflictingAccessCriteria', 'BetaConflictingAccessCriteria'] +slug: /tools/sdk/python/beta/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'BetaConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +**right_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.conflicting_access_criteria import ConflictingAccessCriteria + +conflicting_access_criteria = ConflictingAccessCriteria( +left_criteria=sailpoint.beta.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.beta.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConnectedObject.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectedObject.md new file mode 100644 index 000000000..7d9150448 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectedObject.md @@ -0,0 +1,39 @@ +--- +id: beta-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectedObject', 'BetaConnectedObject'] +slug: /tools/sdk/python/beta/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'BetaConnectedObject'] +--- + +# ConnectedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ConnectedObjectType**](connected-object-type) | | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable name of Connected object | [optional] +**description** | **str** | Description of the Connected object. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.connected_object import ConnectedObject + +connected_object = ConnectedObject( +type='ACCESS_PROFILE', +id='2c91808568c529c60168cca6f90c1313', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConnectedObjectType.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectedObjectType.md new file mode 100644 index 000000000..b1d369021 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectedObjectType.md @@ -0,0 +1,27 @@ +--- +id: beta-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectedObjectType', 'BetaConnectedObjectType'] +slug: /tools/sdk/python/beta/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'BetaConnectedObjectType'] +--- + +# ConnectedObjectType + +An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +* `SOD_POLICY` (value: `'SOD_POLICY'`) + +* `SOURCE` (value: `'SOURCE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConnectorDetail.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorDetail.md new file mode 100644 index 000000000..9d517c99f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorDetail.md @@ -0,0 +1,46 @@ +--- +id: beta-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorDetail', 'BetaConnectorDetail'] +slug: /tools/sdk/python/beta/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'BetaConnectorDetail'] +--- + +# ConnectorDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The connector name | [optional] +**source_config_xml** | **str** | XML representation of the source config data | [optional] +**source_config** | **str** | JSON representation of the source config data | [optional] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] +**file_upload** | **bool** | Connector config's file upload attribute, false if not there | [optional] +**uploaded_files** | **str** | List of uploaded file strings for the connector | [optional] +**connector_metadata** | **object** | Object containing metadata pertinent to the UI to be used | [optional] +} + +## Example + +```python +from sailpoint.beta.models.connector_detail import ConnectorDetail + +connector_detail = ConnectorDetail( +name='JDBC', +source_config_xml='
+
', +source_config='{Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}}', +direct_connect=True, +file_upload=False, +uploaded_files='[]', +connector_metadata={supportedUI=EXTJS} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..29183cf81 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,56 @@ +--- +id: beta-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleCreateRequest', 'BetaConnectorRuleCreateRequest'] +slug: /tools/sdk/python/beta/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'BetaConnectorRuleCreateRequest'] +--- + +# 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', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | 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.beta.models.connector_rule_create_request import ConnectorRuleCreateRequest + +connector_rule_create_request = ConnectorRuleCreateRequest( +name='WebServiceBeforeOperationRule', +description='This rule does that', +type='BuildMap', +signature=sailpoint.beta.models.connector_rule_create_request_signature.ConnectorRuleCreateRequest_signature( + input = [ + sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], + output = sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ), ), +source_code=sailpoint.beta.models.source_code.SourceCode( + version = '1.0', + script = 'return "Mr. " + firstName;', ), +attributes={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..b9b969b46 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,44 @@ +--- +id: beta-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleCreateRequestSignature', 'BetaConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/python/beta/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'BetaConnectorRuleCreateRequestSignature'] +--- + +# 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.beta.models.connector_rule_create_request_signature import ConnectorRuleCreateRequestSignature + +connector_rule_create_request_signature = ConnectorRuleCreateRequestSignature( +input=[ + sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], +output=sailpoint.beta.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/Beta/Models/ConnectorRuleResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..89d817abd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleResponse.md @@ -0,0 +1,62 @@ +--- +id: beta-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleResponse', 'BetaConnectorRuleResponse'] +slug: /tools/sdk/python/beta/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'BetaConnectorRuleResponse'] +--- + +# 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', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | 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.beta.models.connector_rule_response import ConnectorRuleResponse + +connector_rule_response = ConnectorRuleResponse( +name='WebServiceBeforeOperationRule', +description='This rule does that', +type='BuildMap', +signature=sailpoint.beta.models.connector_rule_create_request_signature.ConnectorRuleCreateRequest_signature( + input = [ + sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], + output = sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ), ), +source_code=sailpoint.beta.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/Beta/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..aed2fd2c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,58 @@ +--- +id: beta-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleUpdateRequest', 'BetaConnectorRuleUpdateRequest'] +slug: /tools/sdk/python/beta/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'BetaConnectorRuleUpdateRequest'] +--- + +# 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', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | 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.beta.models.connector_rule_update_request import ConnectorRuleUpdateRequest + +connector_rule_update_request = ConnectorRuleUpdateRequest( +name='WebServiceBeforeOperationRule', +description='This rule does that', +type='BuildMap', +signature=sailpoint.beta.models.connector_rule_create_request_signature.ConnectorRuleCreateRequest_signature( + input = [ + sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], + output = sailpoint.beta.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ), ), +source_code=sailpoint.beta.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/Beta/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..e23e06ff9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,41 @@ +--- +id: beta-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleValidationResponse', 'BetaConnectorRuleValidationResponse'] +slug: /tools/sdk/python/beta/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'BetaConnectorRuleValidationResponse'] +--- + +# 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.beta.models.connector_rule_validation_response import ConnectorRuleValidationResponse + +connector_rule_validation_response = ConnectorRuleValidationResponse( +state='ERROR', +details=[ + sailpoint.beta.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/Beta/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..71d99f73b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,38 @@ +--- +id: beta-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'BetaConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/python/beta/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'BetaConnectorRuleValidationResponseDetailsInner'] +--- + +# 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.beta.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/Beta/Models/ContextAttributeDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ContextAttributeDto.md new file mode 100644 index 000000000..c0158b6df --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ContextAttributeDto.md @@ -0,0 +1,37 @@ +--- +id: beta-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ContextAttributeDto', 'BetaContextAttributeDto'] +slug: /tools/sdk/python/beta/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'BetaContextAttributeDto'] +--- + +# 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.beta.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/Beta/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/python/Reference/Beta/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..ba27de8e5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ContextAttributeDtoValue.md @@ -0,0 +1,32 @@ +--- +id: beta-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ContextAttributeDtoValue', 'BetaContextAttributeDtoValue'] +slug: /tools/sdk/python/beta/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'BetaContextAttributeDtoValue'] +--- + +# 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.beta.models.context_attribute_dto_value import ContextAttributeDtoValue + +context_attribute_dto_value = ContextAttributeDtoValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/python/Reference/Beta/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..0b5d4488f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,47 @@ +--- +id: beta-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CorrelatedGovernanceEvent', 'BetaCorrelatedGovernanceEvent'] +slug: /tools/sdk/python/beta/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'BetaCorrelatedGovernanceEvent'] +--- + +# 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.beta.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.beta.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CorrelationConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/CorrelationConfig.md new file mode 100644 index 000000000..dde238dbc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CorrelationConfig.md @@ -0,0 +1,47 @@ +--- +id: beta-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CorrelationConfig', 'BetaCorrelationConfig'] +slug: /tools/sdk/python/beta/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'BetaCorrelationConfig'] +--- + +# 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.beta.models.correlation_config import CorrelationConfig + +correlation_config = CorrelationConfig( +id='2c9180835d191a86015d28455b4a2329', +name='Source [source] Account Correlation', +attribute_assignments=[ + sailpoint.beta.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/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..4e9f1166e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,46 @@ +--- +id: beta-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'BetaCorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/python/beta/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'BetaCorrelationConfigAttributeAssignmentsInner'] +--- + +# 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.beta.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/Beta/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..e6cca47de --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateDomainDkim405Response.md @@ -0,0 +1,37 @@ +--- +id: beta-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateDomainDkim405Response', 'BetaCreateDomainDkim405Response'] +slug: /tools/sdk/python/beta/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'BetaCreateDomainDkim405Response'] +--- + +# 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.beta.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/Beta/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..610aad3cf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'BetaCreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/python/beta/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'BetaCreateFormDefinitionFileRequestRequest'] +--- + +# CreateFormDefinitionFileRequestRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | File specifying the multipart | [required] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..dbe8cd0eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,87 @@ +--- +id: beta-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateFormDefinitionRequest', 'BetaCreateFormDefinitionRequest'] +slug: /tools/sdk/python/beta/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'BetaCreateFormDefinitionRequest'] +--- + +# 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.beta.models.create_form_definition_request import CreateFormDefinitionRequest + +create_form_definition_request = CreateFormDefinitionRequest( +description='My form description', +form_conditions=[ + sailpoint.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], +form_elements=[ + sailpoint.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_input=[ + sailpoint.beta.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.beta.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), +used_by=[ + sailpoint.beta.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/Beta/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..affd45715 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateFormInstanceRequest.md @@ -0,0 +1,53 @@ +--- +id: beta-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateFormInstanceRequest', 'BetaCreateFormInstanceRequest'] +slug: /tools/sdk/python/beta/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'BetaCreateFormInstanceRequest'] +--- + +# 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.beta.models.create_form_instance_request import CreateFormInstanceRequest + +create_form_instance_request = CreateFormInstanceRequest( +created_by=sailpoint.beta.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.beta.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/Beta/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..2d5293d39 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateOAuthClientRequest.md @@ -0,0 +1,61 @@ +--- +id: beta-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateOAuthClientRequest', 'BetaCreateOAuthClientRequest'] +slug: /tools/sdk/python/beta/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'BetaCreateOAuthClientRequest'] +--- + +# 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.beta.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, http://localhost:67890], +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/Beta/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..9e99d8821 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateOAuthClientResponse.md @@ -0,0 +1,69 @@ +--- +id: beta-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateOAuthClientResponse', 'BetaCreateOAuthClientResponse'] +slug: /tools/sdk/python/beta/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'BetaCreateOAuthClientResponse'] +--- + +# 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.beta.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/Beta/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..4485037d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,38 @@ +--- +id: beta-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreatePersonalAccessTokenRequest', 'BetaCreatePersonalAccessTokenRequest'] +slug: /tools/sdk/python/beta/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'BetaCreatePersonalAccessTokenRequest'] +--- + +# 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.beta.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/Beta/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..5bf06f044 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,48 @@ +--- +id: beta-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreatePersonalAccessTokenResponse', 'BetaCreatePersonalAccessTokenResponse'] +slug: /tools/sdk/python/beta/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'BetaCreatePersonalAccessTokenResponse'] +--- + +# 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.beta.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.beta.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/Beta/Models/CreateWorkflowRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..454cc2ccc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CreateWorkflowRequest.md @@ -0,0 +1,51 @@ +--- +id: beta-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateWorkflowRequest', 'BetaCreateWorkflowRequest'] +slug: /tools/sdk/python/beta/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'BetaCreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [required] +**owner** | [**WorkflowBodyOwner**](workflow-body-owner) | | [required] +**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.beta.models.create_workflow_request import CreateWorkflowRequest + +create_workflow_request = CreateWorkflowRequest( +name='Send Email', +owner=sailpoint.beta.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.beta.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.beta.models.workflow_trigger.WorkflowTrigger( + type = 'EVENT', + display_name = '', + attributes = null, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/CustomPasswordInstruction.md b/docs/tools/sdk/python/Reference/Beta/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..a819039b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/CustomPasswordInstruction.md @@ -0,0 +1,37 @@ +--- +id: beta-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CustomPasswordInstruction', 'BetaCustomPasswordInstruction'] +slug: /tools/sdk/python/beta/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'BetaCustomPasswordInstruction'] +--- + +# 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.beta.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/Beta/Models/Delete202Response.md b/docs/tools/sdk/python/Reference/Beta/Models/Delete202Response.md new file mode 100644 index 000000000..7a4d6d885 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Delete202Response.md @@ -0,0 +1,37 @@ +--- +id: beta-delete202-response +title: Delete202Response +pagination_label: Delete202Response +sidebar_label: Delete202Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Delete202Response', 'BetaDelete202Response'] +slug: /tools/sdk/python/beta/models/delete202-response +tags: ['SDK', 'Software Development Kit', 'Delete202Response', 'BetaDelete202Response'] +--- + +# Delete202Response + + +## 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.beta.models.delete202_response import Delete202Response + +delete202_response = Delete202Response( +type='TASK_RESULT', +id='2c91808779ecf55b0179f720942f181a', +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/DeleteCampaignsRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/DeleteCampaignsRequest.md new file mode 100644 index 000000000..3b491c339 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DeleteCampaignsRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-delete-campaigns-request +title: DeleteCampaignsRequest +pagination_label: DeleteCampaignsRequest +sidebar_label: DeleteCampaignsRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteCampaignsRequest', 'BetaDeleteCampaignsRequest'] +slug: /tools/sdk/python/beta/models/delete-campaigns-request +tags: ['SDK', 'Software Development Kit', 'DeleteCampaignsRequest', 'BetaDeleteCampaignsRequest'] +--- + +# DeleteCampaignsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The ids of the campaigns to delete | [optional] +} + +## Example + +```python +from sailpoint.beta.models.delete_campaigns_request import DeleteCampaignsRequest + +delete_campaigns_request = DeleteCampaignsRequest( +ids=[2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/DeleteNonEmployeeRecordInBulkRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/DeleteNonEmployeeRecordInBulkRequest.md new file mode 100644 index 000000000..49916362a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DeleteNonEmployeeRecordInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-delete-non-employee-record-in-bulk-request +title: DeleteNonEmployeeRecordInBulkRequest +pagination_label: DeleteNonEmployeeRecordInBulkRequest +sidebar_label: DeleteNonEmployeeRecordInBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteNonEmployeeRecordInBulkRequest', 'BetaDeleteNonEmployeeRecordInBulkRequest'] +slug: /tools/sdk/python/beta/models/delete-non-employee-record-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordInBulkRequest', 'BetaDeleteNonEmployeeRecordInBulkRequest'] +--- + +# DeleteNonEmployeeRecordInBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of non-employee ids. | [required] +} + +## Example + +```python +from sailpoint.beta.models.delete_non_employee_record_in_bulk_request import DeleteNonEmployeeRecordInBulkRequest + +delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest( +ids=[ + '' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..9bd46a672 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,33 @@ +--- +id: beta-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteVendorConnectorMapping200Response', 'BetaDeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/python/beta/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'BetaDeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | The number of vendor connector mappings successfully deleted. | [optional] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/DimensionRef.md b/docs/tools/sdk/python/Reference/Beta/Models/DimensionRef.md new file mode 100644 index 000000000..1d2d04206 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DimensionRef.md @@ -0,0 +1,37 @@ +--- +id: beta-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionRef', 'BetaDimensionRef'] +slug: /tools/sdk/python/beta/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'BetaDimensionRef'] +--- + +# 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.beta.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/Beta/Models/DkimAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/DkimAttributes.md new file mode 100644 index 000000000..13fa14df9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DkimAttributes.md @@ -0,0 +1,42 @@ +--- +id: beta-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DkimAttributes', 'BetaDkimAttributes'] +slug: /tools/sdk/python/beta/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'BetaDkimAttributes'] +--- + +# 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.beta.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/Beta/Models/DomainAddress.md b/docs/tools/sdk/python/Reference/Beta/Models/DomainAddress.md new file mode 100644 index 000000000..abd95c655 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DomainAddress.md @@ -0,0 +1,33 @@ +--- +id: beta-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DomainAddress', 'BetaDomainAddress'] +slug: /tools/sdk/python/beta/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'BetaDomainAddress'] +--- + +# DomainAddress + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domain** | **str** | A domain address | [optional] +} + +## Example + +```python +from sailpoint.beta.models.domain_address import DomainAddress + +domain_address = DomainAddress( +domain='sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/DomainStatusDto.md b/docs/tools/sdk/python/Reference/Beta/Models/DomainStatusDto.md new file mode 100644 index 000000000..fd11969af --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DomainStatusDto.md @@ -0,0 +1,42 @@ +--- +id: beta-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DomainStatusDto', 'BetaDomainStatusDto'] +slug: /tools/sdk/python/beta/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'BetaDomainStatusDto'] +--- + +# 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.beta.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/Beta/Models/DtoType.md b/docs/tools/sdk/python/Reference/Beta/Models/DtoType.md new file mode 100644 index 000000000..56b2fd539 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DtoType.md @@ -0,0 +1,77 @@ +--- +id: beta-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DtoType', 'BetaDtoType'] +slug: /tools/sdk/python/beta/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'BetaDtoType'] +--- + +# 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/Beta/Models/DuoVerificationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/DuoVerificationRequest.md new file mode 100644 index 000000000..b969aa98e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/DuoVerificationRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-duo-verification-request +title: DuoVerificationRequest +pagination_label: DuoVerificationRequest +sidebar_label: DuoVerificationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DuoVerificationRequest', 'BetaDuoVerificationRequest'] +slug: /tools/sdk/python/beta/models/duo-verification-request +tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest', 'BetaDuoVerificationRequest'] +--- + +# 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.beta.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/Beta/Models/EmailNotificationOption.md b/docs/tools/sdk/python/Reference/Beta/Models/EmailNotificationOption.md new file mode 100644 index 000000000..581408848 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EmailNotificationOption.md @@ -0,0 +1,39 @@ +--- +id: beta-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EmailNotificationOption', 'BetaEmailNotificationOption'] +slug: /tools/sdk/python/beta/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'BetaEmailNotificationOption'] +--- + +# EmailNotificationOption + + +## 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.beta.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/Beta/Models/EmailStatusDto.md b/docs/tools/sdk/python/Reference/Beta/Models/EmailStatusDto.md new file mode 100644 index 000000000..1cf4e633f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EmailStatusDto.md @@ -0,0 +1,39 @@ +--- +id: beta-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EmailStatusDto', 'BetaEmailStatusDto'] +slug: /tools/sdk/python/beta/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'BetaEmailStatusDto'] +--- + +# 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.beta.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/Beta/Models/Entitlement.md b/docs/tools/sdk/python/Reference/Beta/Models/Entitlement.md new file mode 100644 index 000000000..0e50396e9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Entitlement.md @@ -0,0 +1,76 @@ +--- +id: beta-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Entitlement', 'BetaEntitlement'] +slug: /tools/sdk/python/beta/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'BetaEntitlement'] +--- + +# Entitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The entitlement id | [optional] +**name** | **str** | The entitlement name | [optional] +**created** | **datetime** | Time when the entitlement was created | [optional] +**modified** | **datetime** | Time when the entitlement was last modified | [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] +**privileged** | **bool** | True if the entitlement is privileged | [optional] [default to False] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] [default to False] +**description** | **str** | The description of the entitlement | [optional] +**requestable** | **bool** | True if the entitlement is requestable | [optional] [default to False] +**attributes** | **map[string]object** | A map of free-form key-value pairs from the source system | [optional] +**source** | [**EntitlementSource**](entitlement-source) | | [optional] +**owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] +**direct_permissions** | [**[]PermissionDto**](permission-dto) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**manually_updated_fields** | [**EntitlementManuallyUpdatedFields**](entitlement-manually-updated-fields) | | [optional] +**access_model_metadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.entitlement import Entitlement + +entitlement = Entitlement( +id='2c91808874ff91550175097daaec161c', +name='LauncherTest2', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +attribute='memberOf', +value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +source_schema_object_type='group', +privileged=True, +cloud_governed=True, +description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +requestable=True, +attributes={fieldName=fieldValue}, +source=sailpoint.beta.models.entitlement_source.Entitlement_source( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', ), +owner=, +direct_permissions=[ + sailpoint.beta.models.permission_dto.PermissionDto( + rights = [ + 'SELECT' + ], + target = 'SYS.GV_$TRANSACTION', ) + ], +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +manually_updated_fields=, +access_model_metadata= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..75a3f1558 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,33 @@ +--- +id: beta-entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementAccessModelMetadata', 'BetaEntitlementAccessModelMetadata'] +slug: /tools/sdk/python/beta/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'BetaEntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.entitlement_access_model_metadata import EntitlementAccessModelMetadata + +entitlement_access_model_metadata = EntitlementAccessModelMetadata( +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}]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..4097caa80 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementAccessRequestConfig', 'BetaEntitlementAccessRequestConfig'] +slug: /tools/sdk/python/beta/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'BetaEntitlementAccessRequestConfig'] +--- + +# 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.beta.models.entitlement_access_request_config import EntitlementAccessRequestConfig + +entitlement_access_request_config = EntitlementAccessRequestConfig( +approval_schemes=[ + sailpoint.beta.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/Beta/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..8dca7e583 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementApprovalScheme.md @@ -0,0 +1,35 @@ +--- +id: beta-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementApprovalScheme', 'BetaEntitlementApprovalScheme'] +slug: /tools/sdk/python/beta/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'BetaEntitlementApprovalScheme'] +--- + +# 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.beta.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/Beta/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..f9b7b455a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementBulkUpdateRequest', 'BetaEntitlementBulkUpdateRequest'] +slug: /tools/sdk/python/beta/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'BetaEntitlementBulkUpdateRequest'] +--- + +# 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.beta.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/Beta/Models/EntitlementManuallyUpdatedFields.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementManuallyUpdatedFields.md new file mode 100644 index 000000000..bfc2cf636 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementManuallyUpdatedFields.md @@ -0,0 +1,35 @@ +--- +id: beta-entitlement-manually-updated-fields +title: EntitlementManuallyUpdatedFields +pagination_label: EntitlementManuallyUpdatedFields +sidebar_label: EntitlementManuallyUpdatedFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementManuallyUpdatedFields', 'BetaEntitlementManuallyUpdatedFields'] +slug: /tools/sdk/python/beta/models/entitlement-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementManuallyUpdatedFields', 'BetaEntitlementManuallyUpdatedFields'] +--- + +# EntitlementManuallyUpdatedFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_name** | **bool** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to False] +**description** | **bool** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.entitlement_manually_updated_fields import EntitlementManuallyUpdatedFields + +entitlement_manually_updated_fields = EntitlementManuallyUpdatedFields( +display_name=True, +description=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/EntitlementOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementOwner.md new file mode 100644 index 000000000..f811a19c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementOwner.md @@ -0,0 +1,37 @@ +--- +id: beta-entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementOwner', 'BetaEntitlementOwner'] +slug: /tools/sdk/python/beta/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'BetaEntitlementOwner'] +--- + +# EntitlementOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The owner id for the entitlement | [optional] +**name** | **str** | The owner name for the entitlement | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the owner. Initially only type IDENTITY is supported | [optional] +} + +## Example + +```python +from sailpoint.beta.models.entitlement_owner import EntitlementOwner + +entitlement_owner = EntitlementOwner( +id='2a2fdacca5e345f18bf7970cfbb8fec2', +name='identity 1', +type='IDENTITY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRef.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRef.md new file mode 100644 index 000000000..a4cacbe4b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRef.md @@ -0,0 +1,38 @@ +--- +id: beta-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRef', 'BetaEntitlementRef'] +slug: /tools/sdk/python/beta/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'BetaEntitlementRef'] +--- + +# 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.beta.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/Beta/Models/EntitlementRequestConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..c799ab5fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRequestConfig.md @@ -0,0 +1,40 @@ +--- +id: beta-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRequestConfig', 'BetaEntitlementRequestConfig'] +slug: /tools/sdk/python/beta/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'BetaEntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_config** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig + +entitlement_request_config = EntitlementRequestConfig( +access_request_config=sailpoint.beta.models.entitlement_access_request_config.EntitlementAccessRequestConfig( + approval_schemes = [ + sailpoint.beta.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/Beta/Models/EntitlementRequestConfig1.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRequestConfig1.md new file mode 100644 index 000000000..1bee8fdfc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementRequestConfig1.md @@ -0,0 +1,39 @@ +--- +id: beta-entitlement-request-config1 +title: EntitlementRequestConfig1 +pagination_label: EntitlementRequestConfig1 +sidebar_label: EntitlementRequestConfig1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRequestConfig1', 'BetaEntitlementRequestConfig1'] +slug: /tools/sdk/python/beta/models/entitlement-request-config1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1', 'BetaEntitlementRequestConfig1'] +--- + +# EntitlementRequestConfig1 + + +## 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.beta.models.entitlement_request_config1 import EntitlementRequestConfig1 + +entitlement_request_config1 = EntitlementRequestConfig1( +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/Beta/Models/EntitlementSource.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementSource.md new file mode 100644 index 000000000..9e81d8b9a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementSource.md @@ -0,0 +1,37 @@ +--- +id: beta-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSource', 'BetaEntitlementSource'] +slug: /tools/sdk/python/beta/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'BetaEntitlementSource'] +--- + +# 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.beta.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/Beta/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..53f266bfc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,37 @@ +--- +id: beta-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'BetaEntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/python/beta/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'BetaEntitlementSourceResetBaseReferenceDto'] +--- + +# 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.beta.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/Beta/Models/EntityCreatedByDTO.md b/docs/tools/sdk/python/Reference/Beta/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..92d961334 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EntityCreatedByDTO.md @@ -0,0 +1,35 @@ +--- +id: beta-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntityCreatedByDTO', 'BetaEntityCreatedByDTO'] +slug: /tools/sdk/python/beta/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'BetaEntityCreatedByDTO'] +--- + +# 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.beta.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/Beta/Models/Error.md b/docs/tools/sdk/python/Reference/Beta/Models/Error.md new file mode 100644 index 000000000..620a35fd9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Error.md @@ -0,0 +1,42 @@ +--- +id: beta-error +title: Error +pagination_label: Error +sidebar_label: Error +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Error', 'BetaError'] +slug: /tools/sdk/python/beta/models/error +tags: ['SDK', 'Software Development Kit', 'Error', 'BetaError'] +--- + +# 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.beta.models.error import Error + +error = Error( +detail_code='Internal Server Error', +messages=[ + sailpoint.beta.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/Beta/Models/ErrorMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/ErrorMessage.md new file mode 100644 index 000000000..17a55fd6c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ErrorMessage.md @@ -0,0 +1,37 @@ +--- +id: beta-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorMessage', 'BetaErrorMessage'] +slug: /tools/sdk/python/beta/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'BetaErrorMessage'] +--- + +# 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.beta.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/Beta/Models/ErrorMessageDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ErrorMessageDto.md new file mode 100644 index 000000000..afb6a5da0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ErrorMessageDto.md @@ -0,0 +1,37 @@ +--- +id: beta-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorMessageDto', 'BetaErrorMessageDto'] +slug: /tools/sdk/python/beta/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'BetaErrorMessageDto'] +--- + +# 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.beta.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/Beta/Models/ErrorResponseDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ErrorResponseDto.md new file mode 100644 index 000000000..576ddc95a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ErrorResponseDto.md @@ -0,0 +1,49 @@ +--- +id: beta-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorResponseDto', 'BetaErrorResponseDto'] +slug: /tools/sdk/python/beta/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'BetaErrorResponseDto'] +--- + +# 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.beta.models.error_response_dto import ErrorResponseDto + +error_response_dto = ErrorResponseDto( +detail_code='400.1 Bad Request Content', +tracking_id='e7eab60924f64aa284175b9fa3309599', +messages=[ + sailpoint.beta.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.beta.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/Beta/Models/EvaluateResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/EvaluateResponse.md new file mode 100644 index 000000000..4c5c494a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EvaluateResponse.md @@ -0,0 +1,41 @@ +--- +id: beta-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EvaluateResponse', 'BetaEvaluateResponse'] +slug: /tools/sdk/python/beta/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'BetaEvaluateResponse'] +--- + +# 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.beta.models.evaluate_response import EvaluateResponse + +evaluate_response = EvaluateResponse( +reassign_to_id='869320b6b6f34a169b6178b1a865e66f', +lookup_trail=[ + sailpoint.beta.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/Beta/Models/EventAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/EventAttributes.md new file mode 100644 index 000000000..ba30dcb04 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EventAttributes.md @@ -0,0 +1,38 @@ +--- +id: beta-event-attributes +title: EventAttributes +pagination_label: EventAttributes +sidebar_label: EventAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventAttributes', 'BetaEventAttributes'] +slug: /tools/sdk/python/beta/models/event-attributes +tags: ['SDK', 'Software Development Kit', 'EventAttributes', 'BetaEventAttributes'] +--- + +# 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] +} + +## Example + +```python +from sailpoint.beta.models.event_attributes import EventAttributes + +event_attributes = EventAttributes( +id='idn:identity-attributes-changed', +filter_='$.changes[?(@.attribute == 'manager')]', +description='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/EventBridgeConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/EventBridgeConfig.md new file mode 100644 index 000000000..df82f2a99 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/EventBridgeConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventBridgeConfig', 'BetaEventBridgeConfig'] +slug: /tools/sdk/python/beta/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'BetaEventBridgeConfig'] +--- + +# 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.beta.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/Beta/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..39c714f09 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionAccessCriteria', 'BetaExceptionAccessCriteria'] +slug: /tools/sdk/python/beta/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'BetaExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**ExceptionCriteria**](exception-criteria) | | [optional] +**right_criteria** | [**ExceptionCriteria**](exception-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.exception_access_criteria import ExceptionAccessCriteria + +exception_access_criteria = ExceptionAccessCriteria( +left_criteria=sailpoint.beta.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ), +right_criteria=sailpoint.beta.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/Beta/Models/ExceptionCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionCriteria.md new file mode 100644 index 000000000..5dbaf8e54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionCriteria.md @@ -0,0 +1,33 @@ +--- +id: beta-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteria', 'BetaExceptionCriteria'] +slug: /tools/sdk/python/beta/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'BetaExceptionCriteria'] +--- + +# 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.beta.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/Beta/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..4e9d7913d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,40 @@ +--- +id: beta-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteriaAccess', 'BetaExceptionCriteriaAccess'] +slug: /tools/sdk/python/beta/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'BetaExceptionCriteriaAccess'] +--- + +# 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] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..c39eb8580 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,40 @@ +--- +id: beta-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'BetaExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/python/beta/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'BetaExceptionCriteriaCriteriaListInner'] +--- + +# 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] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/ExecutionStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/ExecutionStatus.md new file mode 100644 index 000000000..e52543162 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExecutionStatus.md @@ -0,0 +1,27 @@ +--- +id: beta-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExecutionStatus', 'BetaExecutionStatus'] +slug: /tools/sdk/python/beta/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'BetaExecutionStatus'] +--- + +# 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/Beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..41663cf22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,92 @@ +--- +id: beta-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'BetaExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/python/beta/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'BetaExportFormDefinitionsByTenant200ResponseInner'] +--- + +# ExportFormDefinitionsByTenant200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | [**FormDefinitionResponse**](form-definition-response) | | [optional] +**var_self** | [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] +**version** | **int** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner + +export_form_definitions_by_tenant200_response_inner = ExportFormDefinitionsByTenant200ResponseInner( +object=sailpoint.beta.models.form_definition_response.FormDefinitionResponse( + id = '00000000-0000-0000-0000-000000000000', + name = 'My form', + description = 'My form description', + owner = sailpoint.beta.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), + used_by = [ + sailpoint.beta.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], + form_input = [ + sailpoint.beta.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.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], + form_conditions = [ + sailpoint.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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.beta.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/Beta/Models/ExportOptions.md b/docs/tools/sdk/python/Reference/Beta/Models/ExportOptions.md new file mode 100644 index 000000000..748ad33aa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExportOptions.md @@ -0,0 +1,41 @@ +--- +id: beta-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportOptions', 'BetaExportOptions'] +slug: /tools/sdk/python/beta/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'BetaExportOptions'] +--- + +# 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.beta.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/Beta/Models/ExportPayload.md b/docs/tools/sdk/python/Reference/Beta/Models/ExportPayload.md new file mode 100644 index 000000000..31c96f5bf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExportPayload.md @@ -0,0 +1,43 @@ +--- +id: beta-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportPayload', 'BetaExportPayload'] +slug: /tools/sdk/python/beta/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'BetaExportPayload'] +--- + +# 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.beta.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/Beta/Models/Expression.md b/docs/tools/sdk/python/Reference/Beta/Models/Expression.md new file mode 100644 index 000000000..20450cda5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Expression.md @@ -0,0 +1,40 @@ +--- +id: beta-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Expression', 'BetaExpression'] +slug: /tools/sdk/python/beta/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'BetaExpression'] +--- + +# 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** | [**[]Children**](children) | List of expressions | [optional] +} + +## Example + +```python +from sailpoint.beta.models.expression import Expression + +expression = Expression( +operator='EQUALS', +attribute='location', +value=sailpoint.beta.models.value.Value( + type = 'STRING', ), +children=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ExternalAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/ExternalAttributes.md new file mode 100644 index 000000000..e6744388c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ExternalAttributes.md @@ -0,0 +1,40 @@ +--- +id: beta-external-attributes +title: ExternalAttributes +pagination_label: ExternalAttributes +sidebar_label: ExternalAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExternalAttributes', 'BetaExternalAttributes'] +slug: /tools/sdk/python/beta/models/external-attributes +tags: ['SDK', 'Software Development Kit', 'ExternalAttributes', 'BetaExternalAttributes'] +--- + +# 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.beta.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/Beta/Models/FeatureValueDto.md b/docs/tools/sdk/python/Reference/Beta/Models/FeatureValueDto.md new file mode 100644 index 000000000..ad611e056 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FeatureValueDto.md @@ -0,0 +1,37 @@ +--- +id: beta-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FeatureValueDto', 'BetaFeatureValueDto'] +slug: /tools/sdk/python/beta/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'BetaFeatureValueDto'] +--- + +# 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.beta.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/Beta/Models/FieldDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/FieldDetails.md new file mode 100644 index 000000000..4cca92f35 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FieldDetails.md @@ -0,0 +1,43 @@ +--- +id: beta-field-details +title: FieldDetails +pagination_label: FieldDetails +sidebar_label: FieldDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FieldDetails', 'BetaFieldDetails'] +slug: /tools/sdk/python/beta/models/field-details +tags: ['SDK', 'Software Development Kit', 'FieldDetails', 'BetaFieldDetails'] +--- + +# FieldDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +**display_name** | **str** | Display name of the field | [optional] +**display_type** | **str** | Type of the field to display | [optional] +**required** | **bool** | True if the field is required | [optional] +**allowed_values_list** | **[]object** | List of allowed values for the field | [optional] +**value** | **object** | Value of the field | [optional] +} + +## Example + +```python +from sailpoint.beta.models.field_details import FieldDetails + +field_details = FieldDetails( +name='Field1', +display_name='Field 1', +display_type='checkbox', +required=True, +allowed_values_list=[{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}], +value=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FieldDetailsDto.md b/docs/tools/sdk/python/Reference/Beta/Models/FieldDetailsDto.md new file mode 100644 index 000000000..1d0a84fe1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FieldDetailsDto.md @@ -0,0 +1,43 @@ +--- +id: beta-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FieldDetailsDto', 'BetaFieldDetailsDto'] +slug: /tools/sdk/python/beta/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'BetaFieldDetailsDto'] +--- + +# 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.beta.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/Beta/Models/Form.md b/docs/tools/sdk/python/Reference/Beta/Models/Form.md new file mode 100644 index 000000000..bf9e277aa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Form.md @@ -0,0 +1,45 @@ +--- +id: beta-form +title: Form +pagination_label: Form +sidebar_label: Form +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Form', 'BetaForm'] +slug: /tools/sdk/python/beta/models/form +tags: ['SDK', 'Software Development Kit', 'Form', 'BetaForm'] +--- + +# Form + + +## 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) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.form import Form + +form = Form( +id='2c9180835d2e5168015d32f890ca1581', +name='AccountSelection Form', +title='Account Selection for John.Doe', +subtitle='Please select from the following', +target_user='Jane.Doe', +sections=[ + sailpoint.beta.models.section_details.SectionDetails() + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FormCondition.md b/docs/tools/sdk/python/Reference/Beta/Models/FormCondition.md new file mode 100644 index 000000000..d1ea85727 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormCondition.md @@ -0,0 +1,51 @@ +--- +id: beta-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormCondition', 'BetaFormCondition'] +slug: /tools/sdk/python/beta/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'BetaFormCondition'] +--- + +# 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.beta.models.form_condition import FormCondition + +form_condition = FormCondition( +rule_operator='AND', +rules=[ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], +effects=[ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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/Beta/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..74076388c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,42 @@ +--- +id: beta-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'BetaFormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/python/beta/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'BetaFormDefinitionDynamicSchemaRequest'] +--- + +# 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.beta.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest + +form_definition_dynamic_schema_request = FormDefinitionDynamicSchemaRequest( +attributes=sailpoint.beta.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/Beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..eb1014ecf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,33 @@ +--- +id: beta-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'BetaFormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/python/beta/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'BetaFormDefinitionDynamicSchemaRequestAttributes'] +--- + +# FormDefinitionDynamicSchemaRequestAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**form_definition_id** | **str** | FormDefinitionID is a unique guid identifying this form definition | [optional] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..7b146b93f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,33 @@ +--- +id: beta-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'BetaFormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/python/beta/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'BetaFormDefinitionDynamicSchemaResponse'] +--- + +# FormDefinitionDynamicSchemaResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**output_schema** | **map[string]object** | OutputSchema holds a JSON schema generated dynamically | [optional] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..927f736ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionFileUploadResponse', 'BetaFormDefinitionFileUploadResponse'] +slug: /tools/sdk/python/beta/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'BetaFormDefinitionFileUploadResponse'] +--- + +# 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.beta.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/Beta/Models/FormDefinitionInput.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionInput.md new file mode 100644 index 000000000..ec8b68b77 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionInput.md @@ -0,0 +1,39 @@ +--- +id: beta-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionInput', 'BetaFormDefinitionInput'] +slug: /tools/sdk/python/beta/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'BetaFormDefinitionInput'] +--- + +# FormDefinitionInput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the form input. | [optional] +**type** | **Enum** [ 'STRING' ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**label** | **str** | Name for the form input. | [optional] +**description** | **str** | Form input's description. | [optional] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/FormDefinitionResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..a6cdd0aa1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionResponse.md @@ -0,0 +1,93 @@ +--- +id: beta-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionResponse', 'BetaFormDefinitionResponse'] +slug: /tools/sdk/python/beta/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'BetaFormDefinitionResponse'] +--- + +# 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.beta.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.beta.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), +used_by=[ + sailpoint.beta.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], +form_input=[ + sailpoint.beta.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.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_conditions=[ + sailpoint.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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/Beta/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionSelfImportExportDto.md new file mode 100644 index 000000000..8f60745a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionSelfImportExportDto.md @@ -0,0 +1,38 @@ +--- +id: beta-form-definition-self-import-export-dto +title: FormDefinitionSelfImportExportDto +pagination_label: FormDefinitionSelfImportExportDto +sidebar_label: FormDefinitionSelfImportExportDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionSelfImportExportDto', 'BetaFormDefinitionSelfImportExportDto'] +slug: /tools/sdk/python/beta/models/form-definition-self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'BetaFormDefinitionSelfImportExportDto'] +--- + +# 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.beta.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/Beta/Models/FormDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/FormDetails.md new file mode 100644 index 000000000..04cb85f36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormDetails.md @@ -0,0 +1,45 @@ +--- +id: beta-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDetails', 'BetaFormDetails'] +slug: /tools/sdk/python/beta/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'BetaFormDetails'] +--- + +# 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) | | [optional] +} + +## Example + +```python +from sailpoint.beta.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.beta.models.section_details.SectionDetails() + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FormElement.md b/docs/tools/sdk/python/Reference/Beta/Models/FormElement.md new file mode 100644 index 000000000..cdfa2a96f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormElement.md @@ -0,0 +1,44 @@ +--- +id: beta-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElement', 'BetaFormElement'] +slug: /tools/sdk/python/beta/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'BetaFormElement'] +--- + +# 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.beta.models.form_element import FormElement + +form_element = FormElement( +id='00000000-0000-0000-0000-000000000000', +element_type='TEXT', +config={label=Department}, +key='department', +validations=[ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/python/Reference/Beta/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..723cdeb2e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,37 @@ +--- +id: beta-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementDataSourceConfigOptions', 'BetaFormElementDataSourceConfigOptions'] +slug: /tools/sdk/python/beta/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'BetaFormElementDataSourceConfigOptions'] +--- + +# 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.beta.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/Beta/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/python/Reference/Beta/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..2a0e1786f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormElementDynamicDataSource.md @@ -0,0 +1,39 @@ +--- +id: beta-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementDynamicDataSource', 'BetaFormElementDynamicDataSource'] +slug: /tools/sdk/python/beta/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'BetaFormElementDynamicDataSource'] +--- + +# 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.beta.models.form_element_dynamic_data_source import FormElementDynamicDataSource + +form_element_dynamic_data_source = FormElementDynamicDataSource( +config=sailpoint.beta.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/Beta/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..8b945df45 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementDynamicDataSourceConfig', 'BetaFormElementDynamicDataSourceConfig'] +slug: /tools/sdk/python/beta/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'BetaFormElementDynamicDataSourceConfig'] +--- + +# 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.beta.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/Beta/Models/FormElementPreviewRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..624a78e69 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormElementPreviewRequest.md @@ -0,0 +1,39 @@ +--- +id: beta-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementPreviewRequest', 'BetaFormElementPreviewRequest'] +slug: /tools/sdk/python/beta/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'BetaFormElementPreviewRequest'] +--- + +# FormElementPreviewRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source** | [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.form_element_preview_request import FormElementPreviewRequest + +form_element_preview_request = FormElementPreviewRequest( +data_source=sailpoint.beta.models.form_element_dynamic_data_source.FormElementDynamicDataSource( + config = sailpoint.beta.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/Beta/Models/FormElementValidationsSet.md b/docs/tools/sdk/python/Reference/Beta/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..40e1e3c2f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormElementValidationsSet.md @@ -0,0 +1,34 @@ +--- +id: beta-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementValidationsSet', 'BetaFormElementValidationsSet'] +slug: /tools/sdk/python/beta/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'BetaFormElementValidationsSet'] +--- + +# 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.beta.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/Beta/Models/FormError.md b/docs/tools/sdk/python/Reference/Beta/Models/FormError.md new file mode 100644 index 000000000..d16acd976 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormError.md @@ -0,0 +1,42 @@ +--- +id: beta-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormError', 'BetaFormError'] +slug: /tools/sdk/python/beta/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'BetaFormError'] +--- + +# 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.beta.models.form_error import FormError + +form_error = FormError( +key='department', +messages=[ + sailpoint.beta.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/Beta/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..29adbd236 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceCreatedBy.md @@ -0,0 +1,35 @@ +--- +id: beta-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormInstanceCreatedBy', 'BetaFormInstanceCreatedBy'] +slug: /tools/sdk/python/beta/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'BetaFormInstanceCreatedBy'] +--- + +# 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.beta.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/Beta/Models/FormInstanceRecipient.md b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..275bdb15a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceRecipient.md @@ -0,0 +1,35 @@ +--- +id: beta-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormInstanceRecipient', 'BetaFormInstanceRecipient'] +slug: /tools/sdk/python/beta/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'BetaFormInstanceRecipient'] +--- + +# 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.beta.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/Beta/Models/FormInstanceResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceResponse.md new file mode 100644 index 000000000..b5c0be1ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceResponse.md @@ -0,0 +1,105 @@ +--- +id: beta-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormInstanceResponse', 'BetaFormInstanceResponse'] +slug: /tools/sdk/python/beta/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'BetaFormInstanceResponse'] +--- + +# 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.beta.models.form_instance_response import FormInstanceResponse + +form_instance_response = FormInstanceResponse( +created='2023-07-12T20:14:57.744860Z', +created_by=sailpoint.beta.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.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_errors=[ + sailpoint.beta.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.beta.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.beta.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/Beta/Models/FormItem.md b/docs/tools/sdk/python/Reference/Beta/Models/FormItem.md new file mode 100644 index 000000000..c95d725bb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormItem.md @@ -0,0 +1,33 @@ +--- +id: beta-form-item +title: FormItem +pagination_label: FormItem +sidebar_label: FormItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormItem', 'BetaFormItem'] +slug: /tools/sdk/python/beta/models/form-item +tags: ['SDK', 'Software Development Kit', 'FormItem', 'BetaFormItem'] +--- + +# FormItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +} + +## Example + +```python +from sailpoint.beta.models.form_item import FormItem + +form_item = FormItem( +name='Field1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FormItemDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/FormItemDetails.md new file mode 100644 index 000000000..514d0a05d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormItemDetails.md @@ -0,0 +1,33 @@ +--- +id: beta-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormItemDetails', 'BetaFormItemDetails'] +slug: /tools/sdk/python/beta/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'BetaFormItemDetails'] +--- + +# FormItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +} + +## Example + +```python +from sailpoint.beta.models.form_item_details import FormItemDetails + +form_item_details = FormItemDetails( +name='Field1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FormOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/FormOwner.md new file mode 100644 index 000000000..d47b7e09a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormOwner.md @@ -0,0 +1,37 @@ +--- +id: beta-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormOwner', 'BetaFormOwner'] +slug: /tools/sdk/python/beta/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'BetaFormOwner'] +--- + +# 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.beta.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/Beta/Models/FormUsedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/FormUsedBy.md new file mode 100644 index 000000000..f834dedc1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormUsedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormUsedBy', 'BetaFormUsedBy'] +slug: /tools/sdk/python/beta/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'BetaFormUsedBy'] +--- + +# 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.beta.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/Beta/Models/ForwardApprovalDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..7d9361c86 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ForwardApprovalDto.md @@ -0,0 +1,35 @@ +--- +id: beta-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ForwardApprovalDto', 'BetaForwardApprovalDto'] +slug: /tools/sdk/python/beta/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'BetaForwardApprovalDto'] +--- + +# 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.beta.models.forward_approval_dto import ForwardApprovalDto + +forward_approval_dto = ForwardApprovalDto( +new_owner_id='0', +comment='0' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullDiscoveredApplications.md b/docs/tools/sdk/python/Reference/Beta/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..801d79b51 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullDiscoveredApplications.md @@ -0,0 +1,52 @@ +--- +id: beta-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullDiscoveredApplications', 'BetaFullDiscoveredApplications'] +slug: /tools/sdk/python/beta/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'BetaFullDiscoveredApplications'] +--- + +# 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.beta.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/Beta/Models/Fullcampaign.md b/docs/tools/sdk/python/Reference/Beta/Models/Fullcampaign.md new file mode 100644 index 000000000..353258ef0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Fullcampaign.md @@ -0,0 +1,122 @@ +--- +id: beta-fullcampaign +title: Fullcampaign +pagination_label: Fullcampaign +sidebar_label: Fullcampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Fullcampaign', 'BetaFullcampaign'] +slug: /tools/sdk/python/beta/models/fullcampaign +tags: ['SDK', 'Software Development Kit', 'Fullcampaign', 'BetaFullcampaign'] +--- + +# Fullcampaign + + +## 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** | [**FullcampaignAllOfFilter**](fullcampaign-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** | [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-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.beta.models.fullcampaign import Fullcampaign + +fullcampaign = Fullcampaign( +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.beta.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.beta.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.beta.models.fullcampaign_all_of_filter.fullcampaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.beta.models.fullcampaign_all_of_source_owner_campaign_info.fullcampaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.beta.models.fullcampaign_all_of_search_campaign_info.fullcampaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.beta.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info.fullcampaign_allOf_roleCompositionCampaignInfo( + reviewer = sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info_remediator_ref.fullcampaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.beta.models.fullcampaign_all_of_machine_account_campaign_info.fullcampaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.beta.models.fullcampaign_all_of_sources_with_orphan_entitlements.fullcampaign_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/Beta/Models/FullcampaignAllOfFilter.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfFilter.md new file mode 100644 index 000000000..0e9d17b03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfFilter.md @@ -0,0 +1,38 @@ +--- +id: beta-fullcampaign-all-of-filter +title: FullcampaignAllOfFilter +pagination_label: FullcampaignAllOfFilter +sidebar_label: FullcampaignAllOfFilter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfFilter', 'BetaFullcampaignAllOfFilter'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfFilter', 'BetaFullcampaignAllOfFilter'] +--- + +# FullcampaignAllOfFilter + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of whatever type of filter is being used. | [optional] +**type** | **Enum** [ 'CAMPAIGN_FILTER', 'RULE' ] | Type of the filter | [optional] +**name** | **str** | Name of the filter | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_filter import FullcampaignAllOfFilter + +fullcampaign_all_of_filter = FullcampaignAllOfFilter( +id='0fbe863c063c4c88a35fd7f17e8a3df5', +type='CAMPAIGN_FILTER', +name='Test Filter' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..7b3d564ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,36 @@ +--- +id: beta-fullcampaign-all-of-machine-account-campaign-info +title: FullcampaignAllOfMachineAccountCampaignInfo +pagination_label: FullcampaignAllOfMachineAccountCampaignInfo +sidebar_label: FullcampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfMachineAccountCampaignInfo', 'BetaFullcampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfMachineAccountCampaignInfo', 'BetaFullcampaignAllOfMachineAccountCampaignInfo'] +--- + +# FullcampaignAllOfMachineAccountCampaignInfo + +Must be set only if the campaign type is MACHINE_ACCOUNT. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_ids** | **[]str** | The list of sources to be included in the campaign. | [optional] +**reviewer_type** | **Enum** [ 'ACCOUNT_OWNER' ] | The reviewer's type. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_machine_account_campaign_info import FullcampaignAllOfMachineAccountCampaignInfo + +fullcampaign_all_of_machine_account_campaign_info = FullcampaignAllOfMachineAccountCampaignInfo( +source_ids=[0fbe863c063c4c88a35fd7f17e8a3df5], +reviewer_type='ACCOUNT_OWNER' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..2f40fefb4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,48 @@ +--- +id: beta-fullcampaign-all-of-role-composition-campaign-info +title: FullcampaignAllOfRoleCompositionCampaignInfo +pagination_label: FullcampaignAllOfRoleCompositionCampaignInfo +sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfo', 'BetaFullcampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfo', 'BetaFullcampaignAllOfRoleCompositionCampaignInfo'] +--- + +# FullcampaignAllOfRoleCompositionCampaignInfo + +Optional configuration options for role composition campaigns. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reviewer** | [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] +**role_ids** | **[]str** | 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. | [optional] +**remediator_ref** | [**FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](fullcampaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] +**query** | **str** | 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. | [optional] +**description** | **str** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info import FullcampaignAllOfRoleCompositionCampaignInfo + +fullcampaign_all_of_role_composition_campaign_info = FullcampaignAllOfRoleCompositionCampaignInfo( +reviewer=sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +role_ids=[2c90ad2a70ace7d50170acf22ca90010], +remediator_ref=sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info_remediator_ref.fullcampaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), +query='Search Query', +description='Role Composition Description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..ae72f64b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,38 @@ +--- +id: beta-fullcampaign-all-of-role-composition-campaign-info-remediator-ref +title: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Legal Remediator Type | [required] +**id** | **str** | The ID of the remediator. | [required] +**name** | **str** | The name of the remediator. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info_remediator_ref import FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +fullcampaign_all_of_role_composition_campaign_info_remediator_ref = FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef( +type='IDENTITY', +id='2c90ad2a70ace7d50170acf22ca90010', +name='Role Admin' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..5e7a857ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,52 @@ +--- +id: beta-fullcampaign-all-of-search-campaign-info +title: FullcampaignAllOfSearchCampaignInfo +pagination_label: FullcampaignAllOfSearchCampaignInfo +sidebar_label: FullcampaignAllOfSearchCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfSearchCampaignInfo', 'BetaFullcampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfo', 'BetaFullcampaignAllOfSearchCampaignInfo'] +--- + +# FullcampaignAllOfSearchCampaignInfo + +Must be set only if the campaign type is SEARCH. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'ACCESS' ] | The type of search campaign represented. | [required] +**description** | **str** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**reviewer** | [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] +**query** | **str** | 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. | [optional] +**identity_ids** | **[]str** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**access_constraints** | [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_search_campaign_info import FullcampaignAllOfSearchCampaignInfo + +fullcampaign_all_of_search_campaign_info = FullcampaignAllOfSearchCampaignInfo( +type='ACCESS', +description='Search Campaign description', +reviewer=sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +query='Search Campaign query description', +identity_ids=[0fbe863c063c4c88a35fd7f17e8a3df5], +access_constraints=[ + sailpoint.beta.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..d6660dbbc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,38 @@ +--- +id: beta-fullcampaign-all-of-search-campaign-info-reviewer +title: FullcampaignAllOfSearchCampaignInfoReviewer +pagination_label: FullcampaignAllOfSearchCampaignInfoReviewer +sidebar_label: FullcampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfSearchCampaignInfoReviewer', 'BetaFullcampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfoReviewer', 'BetaFullcampaignAllOfSearchCampaignInfoReviewer'] +--- + +# FullcampaignAllOfSearchCampaignInfoReviewer + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | The reviewer's DTO type. | [optional] +**id** | **str** | The reviewer's ID. | [optional] +**name** | **str** | The reviewer's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer import FullcampaignAllOfSearchCampaignInfoReviewer + +fullcampaign_all_of_search_campaign_info_reviewer = FullcampaignAllOfSearchCampaignInfoReviewer( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..dcb0c876b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,34 @@ +--- +id: beta-fullcampaign-all-of-source-owner-campaign-info +title: FullcampaignAllOfSourceOwnerCampaignInfo +pagination_label: FullcampaignAllOfSourceOwnerCampaignInfo +sidebar_label: FullcampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfSourceOwnerCampaignInfo', 'BetaFullcampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourceOwnerCampaignInfo', 'BetaFullcampaignAllOfSourceOwnerCampaignInfo'] +--- + +# FullcampaignAllOfSourceOwnerCampaignInfo + +Must be set only if the campaign type is SOURCE_OWNER. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_ids** | **[]str** | The list of sources to be included in the campaign. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_source_owner_campaign_info import FullcampaignAllOfSourceOwnerCampaignInfo + +fullcampaign_all_of_source_owner_campaign_info = FullcampaignAllOfSourceOwnerCampaignInfo( +source_ids=[0fbe863c063c4c88a35fd7f17e8a3df5] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..75325b516 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,37 @@ +--- +id: beta-fullcampaign-all-of-sources-with-orphan-entitlements +title: FullcampaignAllOfSourcesWithOrphanEntitlements +pagination_label: FullcampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: FullcampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullcampaignAllOfSourcesWithOrphanEntitlements', 'BetaFullcampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/python/beta/models/fullcampaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourcesWithOrphanEntitlements', 'BetaFullcampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# FullcampaignAllOfSourcesWithOrphanEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the source | [optional] +**type** | **Enum** [ 'SOURCE' ] | Type | [optional] +**name** | **str** | Name of the source | [optional] +} + +## Example + +```python +from sailpoint.beta.models.fullcampaign_all_of_sources_with_orphan_entitlements import FullcampaignAllOfSourcesWithOrphanEntitlements + +fullcampaign_all_of_sources_with_orphan_entitlements = FullcampaignAllOfSourcesWithOrphanEntitlements( +id='2c90ad2a70ace7d50170acf22ca90010', +type='SOURCE', +name='Source with orphan entitlements' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..a3e81c81a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,122 @@ +--- +id: beta-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetActiveCampaigns200ResponseInner', 'BetaGetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/python/beta/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'BetaGetActiveCampaigns200ResponseInner'] +--- + +# 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** | [**FullcampaignAllOfFilter**](fullcampaign-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** | [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-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.beta.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.beta.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.beta.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.beta.models.fullcampaign_all_of_filter.fullcampaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.beta.models.fullcampaign_all_of_source_owner_campaign_info.fullcampaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.beta.models.fullcampaign_all_of_search_campaign_info.fullcampaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.beta.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info.fullcampaign_allOf_roleCompositionCampaignInfo( + reviewer = sailpoint.beta.models.fullcampaign_all_of_search_campaign_info_reviewer.fullcampaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.beta.models.fullcampaign_all_of_role_composition_campaign_info_remediator_ref.fullcampaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.beta.models.fullcampaign_all_of_machine_account_campaign_info.fullcampaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.beta.models.fullcampaign_all_of_sources_with_orphan_entitlements.fullcampaign_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/Beta/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..57be2f4dd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,51 @@ +--- +id: beta-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'BetaGetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/python/beta/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'BetaGetDiscoveredApplications200ResponseInner'] +--- + +# 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.beta.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/Beta/Models/GetFormDefinitionByKey400Response.md b/docs/tools/sdk/python/Reference/Beta/Models/GetFormDefinitionByKey400Response.md new file mode 100644 index 000000000..f624d3773 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetFormDefinitionByKey400Response.md @@ -0,0 +1,44 @@ +--- +id: beta-get-form-definition-by-key400-response +title: GetFormDefinitionByKey400Response +pagination_label: GetFormDefinitionByKey400Response +sidebar_label: GetFormDefinitionByKey400Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetFormDefinitionByKey400Response', 'BetaGetFormDefinitionByKey400Response'] +slug: /tools/sdk/python/beta/models/get-form-definition-by-key400-response +tags: ['SDK', 'Software Development Kit', 'GetFormDefinitionByKey400Response', 'BetaGetFormDefinitionByKey400Response'] +--- + +# GetFormDefinitionByKey400Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail_code** | **str** | | [optional] +**messages** | [**[]ErrorMessage**](error-message) | | [optional] +**status_code** | **int** | | [optional] +**tracking_id** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.get_form_definition_by_key400_response import GetFormDefinitionByKey400Response + +get_form_definition_by_key400_response = GetFormDefinitionByKey400Response( +detail_code='', +messages=[ + sailpoint.beta.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', ) + ], +status_code=56, +tracking_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..8907f378f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,86 @@ +--- +id: beta-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'BetaGetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/python/beta/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'BetaGetHistoricalIdentityEvents200ResponseInner'] +--- + +# 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.beta.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.beta.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.beta.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), ), +changes=[ + {name=firstname, previousValue=adam, newValue=zampa} + ], +access_request=sailpoint.beta.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.beta.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), +account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account( + id = '', + native_identity = '', + display_name = '', + source_id = '', + source_name = '', + entitlement_count = 56, + access_type = '', ), +status_change=sailpoint.beta.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/Beta/Models/GetLaunchers200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/GetLaunchers200Response.md new file mode 100644 index 000000000..b548c2b67 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetLaunchers200Response.md @@ -0,0 +1,51 @@ +--- +id: beta-get-launchers200-response +title: GetLaunchers200Response +pagination_label: GetLaunchers200Response +sidebar_label: GetLaunchers200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetLaunchers200Response', 'BetaGetLaunchers200Response'] +slug: /tools/sdk/python/beta/models/get-launchers200-response +tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'BetaGetLaunchers200Response'] +--- + +# GetLaunchers200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | Pagination marker | [optional] +**items** | [**[]Launcher**](launcher) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.get_launchers200_response import GetLaunchers200Response + +get_launchers200_response = GetLaunchers200Response( +next='', +items=[ + sailpoint.beta.models.launcher.Launcher( + id = '1b630bed-0941-4792-a712-57a5868ca34d', + created = '2024-04-16T20:07:30.601016489Z', + modified = '2024-04-17T18:02:07.320143194Z', + owner = sailpoint.beta.models.launcher_owner.Launcher_owner( + type = 'IDENTITY', + id = '123180847373330f0173c7e1756b6890', ), + name = 'Group Create', + description = 'Create a new Active Directory Group', + type = 'INTERACTIVE_PROCESS', + disabled = False, + reference = sailpoint.beta.models.launcher_reference.Launcher_reference( + type = 'WORKFLOW', + id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ), + config = '{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/GetOAuthClientResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..a40f0f9ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetOAuthClientResponse.md @@ -0,0 +1,73 @@ +--- +id: beta-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetOAuthClientResponse', 'BetaGetOAuthClientResponse'] +slug: /tools/sdk/python/beta/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'BetaGetOAuthClientResponse'] +--- + +# 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.beta.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/Beta/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..4a49026fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,48 @@ +--- +id: beta-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetPersonalAccessTokenResponse', 'BetaGetPersonalAccessTokenResponse'] +slug: /tools/sdk/python/beta/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'BetaGetPersonalAccessTokenResponse'] +--- + +# 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.beta.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.beta.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/Beta/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..34f729f83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,82 @@ +--- +id: beta-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetRoleAssignments200ResponseInner', 'BetaGetRoleAssignments200ResponseInner'] +slug: /tools/sdk/python/beta/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'BetaGetRoleAssignments200ResponseInner'] +--- + +# GetRoleAssignments200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Assignment Id | [optional] +**role** | [**BaseReferenceDto1**](base-reference-dto1) | | [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** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**assigned_dimensions** | [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**assignment_context** | [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**account_targets** | [**[]RoleTargetDto**](role-target-dto) | | [optional] +**remove_date** | **str** | Date that the assignment will be removed | [optional] +} + +## Example + +```python +from sailpoint.beta.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner + +get_role_assignments200_response_inner = GetRoleAssignments200ResponseInner( +id='1cbb0705b38c4226b1334eadd8874086', +role=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), +comments='I'm a new Engineer and need this role to do my work', +assignment_source='UI', +assigner=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), +assigned_dimensions=[{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}], +assignment_context=sailpoint.beta.models.assignment_context_dto.AssignmentContextDto( + requested = sailpoint.beta.models.access_request_context.AccessRequestContext( + context_attributes = [ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ), + matched = [ + sailpoint.beta.models.role_match_dto.RoleMatchDto( + role_ref = sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), + matched_attributes = [ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + derived = False, ) + ], ) + ], + computed_date = 'Wed Feb 14 10:58:42', ), +account_targets=[ + sailpoint.beta.models.role_target_dto.RoleTargetDto( + source = sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), + account_info = sailpoint.beta.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/Beta/Models/GrantType.md b/docs/tools/sdk/python/Reference/Beta/Models/GrantType.md new file mode 100644 index 000000000..d6136af44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/GrantType.md @@ -0,0 +1,25 @@ +--- +id: beta-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GrantType', 'BetaGrantType'] +slug: /tools/sdk/python/beta/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'BetaGrantType'] +--- + +# 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/Beta/Models/HttpAuthenticationType.md b/docs/tools/sdk/python/Reference/Beta/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..f2532555f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/HttpAuthenticationType.md @@ -0,0 +1,25 @@ +--- +id: beta-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'HttpAuthenticationType', 'BetaHttpAuthenticationType'] +slug: /tools/sdk/python/beta/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'BetaHttpAuthenticationType'] +--- + +# 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/Beta/Models/HttpConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/HttpConfig.md new file mode 100644 index 000000000..cb112d2c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/HttpConfig.md @@ -0,0 +1,44 @@ +--- +id: beta-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'HttpConfig', 'BetaHttpConfig'] +slug: /tools/sdk/python/beta/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'BetaHttpConfig'] +--- + +# 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.beta.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.beta.models.basic_auth_config.BasicAuthConfig( + user_name = 'user@example.com', + password = '', ), +bearer_token_auth_config=sailpoint.beta.models.bearer_token_auth_config.BearerTokenAuthConfig( + bearer_token = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/HttpDispatchMode.md b/docs/tools/sdk/python/Reference/Beta/Models/HttpDispatchMode.md new file mode 100644 index 000000000..86d28443f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/HttpDispatchMode.md @@ -0,0 +1,25 @@ +--- +id: beta-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'HttpDispatchMode', 'BetaHttpDispatchMode'] +slug: /tools/sdk/python/beta/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'BetaHttpDispatchMode'] +--- + +# 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/Beta/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..fad85dcc2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitiesAccountsBulkRequest', 'BetaIdentitiesAccountsBulkRequest'] +slug: /tools/sdk/python/beta/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'BetaIdentitiesAccountsBulkRequest'] +--- + +# IdentitiesAccountsBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_ids** | **[]str** | The ids of the identities for which enable/disable accounts. | [optional] +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/Identity.md b/docs/tools/sdk/python/Reference/Beta/Models/Identity.md new file mode 100644 index 000000000..8c7ca3e13 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Identity.md @@ -0,0 +1,60 @@ +--- +id: beta-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity', 'BetaIdentity'] +slug: /tools/sdk/python/beta/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'BetaIdentity'] +--- + +# 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.beta.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.beta.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/Beta/Models/Identity1.md b/docs/tools/sdk/python/Reference/Beta/Models/Identity1.md new file mode 100644 index 000000000..b76af6110 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Identity1.md @@ -0,0 +1,36 @@ +--- +id: beta-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity1', 'BetaIdentity1'] +slug: /tools/sdk/python/beta/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'BetaIdentity1'] +--- + +# 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.beta.models.identity1 import Identity1 + +identity1 = Identity1( +id='2c91808380aa05580180aaaaf1940410', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityAssociationDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..77badbb24 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAssociationDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAssociationDetails', 'BetaIdentityAssociationDetails'] +slug: /tools/sdk/python/beta/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'BetaIdentityAssociationDetails'] +--- + +# 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.beta.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.beta.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/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..aefc661fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'BetaIdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/python/beta/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'BetaIdentityAssociationDetailsAssociationDetailsInner'] +--- + +# 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.beta.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/Beta/Models/IdentityAttribute.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttribute.md new file mode 100644 index 000000000..4ab98e3b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttribute.md @@ -0,0 +1,51 @@ +--- +id: beta-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttribute', 'BetaIdentityAttribute'] +slug: /tools/sdk/python/beta/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'BetaIdentityAttribute'] +--- + +# 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.beta.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.beta.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/Beta/Models/IdentityAttributeConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..00894635c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeConfig', 'BetaIdentityAttributeConfig'] +slug: /tools/sdk/python/beta/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to True] +**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_attribute_config import IdentityAttributeConfig + +identity_attribute_config = IdentityAttributeConfig( +enabled=True, +attribute_transforms=[ + sailpoint.beta.models.identity_attribute_transform.IdentityAttributeTransform( + identity_attribute_name = 'email', + transform_definition = sailpoint.beta.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/Beta/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeConfig1.md new file mode 100644 index 000000000..54d616b9b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeConfig1.md @@ -0,0 +1,42 @@ +--- +id: beta-identity-attribute-config1 +title: IdentityAttributeConfig1 +pagination_label: IdentityAttributeConfig1 +sidebar_label: IdentityAttributeConfig1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeConfig1', 'BetaIdentityAttributeConfig1'] +slug: /tools/sdk/python/beta/models/identity-attribute-config1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdentityAttributeConfig1'] +--- + +# IdentityAttributeConfig1 + +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** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_attribute_config1 import IdentityAttributeConfig1 + +identity_attribute_config1 = IdentityAttributeConfig1( +enabled=True, +attribute_transforms=[ + sailpoint.beta.models.identity_attribute_transform_1.IdentityAttributeTransform_1( + identity_attribute_name = 'email', + transform_definition = sailpoint.beta.models.transform_definition_1.TransformDefinition_1( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeNames.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..86dc26881 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeNames.md @@ -0,0 +1,34 @@ +--- +id: beta-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeNames', 'BetaIdentityAttributeNames'] +slug: /tools/sdk/python/beta/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'BetaIdentityAttributeNames'] +--- + +# IdentityAttributeNames + +Identity attribute IDs. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of identity attributes' technical names. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_attribute_names import IdentityAttributeNames + +identity_attribute_names = IdentityAttributeNames( +ids=[name, displayName] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributePreview.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..1aefaff5d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributePreview.md @@ -0,0 +1,44 @@ +--- +id: beta-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributePreview', 'BetaIdentityAttributePreview'] +slug: /tools/sdk/python/beta/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'BetaIdentityAttributePreview'] +--- + +# 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.beta.models.identity_attribute_preview import IdentityAttributePreview + +identity_attribute_preview = IdentityAttributePreview( +name='email', +value='email@mail.com', +previous_value='oldEmail@mail.com', +error_messages=[ + sailpoint.beta.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/Beta/Models/IdentityAttributeTransform.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..f133181f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeTransform.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeTransform', 'BetaIdentityAttributeTransform'] +slug: /tools/sdk/python/beta/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIdentityAttributeTransform'] +--- + +# 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.beta.models.identity_attribute_transform import IdentityAttributeTransform + +identity_attribute_transform = IdentityAttributeTransform( +identity_attribute_name='email', +transform_definition=sailpoint.beta.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/Beta/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeTransform1.md new file mode 100644 index 000000000..208c96fe1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeTransform1.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-attribute-transform1 +title: IdentityAttributeTransform1 +pagination_label: IdentityAttributeTransform1 +sidebar_label: IdentityAttributeTransform1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeTransform1', 'BetaIdentityAttributeTransform1'] +slug: /tools/sdk/python/beta/models/identity-attribute-transform1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaIdentityAttributeTransform1'] +--- + +# IdentityAttributeTransform1 + +Transform definition for an identity attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attribute_name** | **str** | Identity attribute's name. | [optional] +**transform_definition** | [**TransformDefinition1**](transform-definition1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_attribute_transform1 import IdentityAttributeTransform1 + +identity_attribute_transform1 = IdentityAttributeTransform1( +identity_attribute_name='email', +transform_definition=sailpoint.beta.models.transform_definition_1.TransformDefinition_1( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChanged.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..8be9258c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChanged.md @@ -0,0 +1,43 @@ +--- +id: beta-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChanged', 'BetaIdentityAttributesChanged'] +slug: /tools/sdk/python/beta/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'BetaIdentityAttributesChanged'] +--- + +# 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.beta.models.identity_attributes_changed import IdentityAttributesChanged + +identity_attributes_changed = IdentityAttributesChanged( +identity=sailpoint.beta.models.identity_attributes_changed_identity.IdentityAttributesChanged_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +changes=[ + sailpoint.beta.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/Beta/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..6d0d432a2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInner', 'BetaIdentityAttributesChangedChangesInner'] +slug: /tools/sdk/python/beta/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'BetaIdentityAttributesChangedChangesInner'] +--- + +# 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.beta.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/Beta/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..21ac18eb5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,32 @@ +--- +id: beta-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'BetaIdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/python/beta/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'BetaIdentityAttributesChangedChangesInnerNewValue'] +--- + +# IdentityAttributesChangedChangesInnerNewValue + +The value of the identity attribute after it changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..45bac5551 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,32 @@ +--- +id: beta-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'BetaIdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/python/beta/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'BetaIdentityAttributesChangedChangesInnerOldValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValue + +The value of the identity attribute before it changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..099fdb977 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,31 @@ +--- +id: beta-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', 'BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/python/beta/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.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/Beta/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..c078684db --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedIdentity', 'BetaIdentityAttributesChangedIdentity'] +slug: /tools/sdk/python/beta/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'BetaIdentityAttributesChangedIdentity'] +--- + +# 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.beta.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/Beta/Models/IdentityCertificationTask.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCertificationTask.md new file mode 100644 index 000000000..df4103e42 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCertificationTask.md @@ -0,0 +1,41 @@ +--- +id: beta-identity-certification-task +title: IdentityCertificationTask +pagination_label: IdentityCertificationTask +sidebar_label: IdentityCertificationTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertificationTask', 'BetaIdentityCertificationTask'] +slug: /tools/sdk/python/beta/models/identity-certification-task +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationTask', 'BetaIdentityCertificationTask'] +--- + +# IdentityCertificationTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The task id | [optional] +**certification_id** | **str** | The certification id | [optional] +**type** | **Enum** [ 'REASSIGN' ] | | [optional] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | | [optional] +**errors** | **[]str** | Any errors executing the task (Optional). | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask + +identity_certification_task = IdentityCertificationTask( +id='abcd-ef12-3456', +certification_id='ef38f94347e94562b5bb8424a56397d8', +type='REASSIGN', +status='QUEUED', +errors=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityCertified.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCertified.md new file mode 100644 index 000000000..5ae1d35ea --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCertified.md @@ -0,0 +1,49 @@ +--- +id: beta-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertified', 'BetaIdentityCertified'] +slug: /tools/sdk/python/beta/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'BetaIdentityCertified'] +--- + +# 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.beta.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.beta.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/Beta/Models/IdentityCompareResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..e6b7cbb78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCompareResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCompareResponse', 'BetaIdentityCompareResponse'] +slug: /tools/sdk/python/beta/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'BetaIdentityCompareResponse'] +--- + +# 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.beta.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/Beta/Models/IdentityCreated.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCreated.md new file mode 100644 index 000000000..13ee8f768 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCreated.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCreated', 'BetaIdentityCreated'] +slug: /tools/sdk/python/beta/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'BetaIdentityCreated'] +--- + +# 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.beta.models.identity_created import IdentityCreated + +identity_created = IdentityCreated( +identity=sailpoint.beta.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/Beta/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..f8abfcac4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityCreatedIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCreatedIdentity', 'BetaIdentityCreatedIdentity'] +slug: /tools/sdk/python/beta/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'BetaIdentityCreatedIdentity'] +--- + +# 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.beta.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/Beta/Models/IdentityDeleted.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityDeleted.md new file mode 100644 index 000000000..8acd3f4b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityDeleted.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDeleted', 'BetaIdentityDeleted'] +slug: /tools/sdk/python/beta/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'BetaIdentityDeleted'] +--- + +# 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.beta.models.identity_deleted import IdentityDeleted + +identity_deleted = IdentityDeleted( +identity=sailpoint.beta.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/Beta/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..976706b18 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityDeletedIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDeletedIdentity', 'BetaIdentityDeletedIdentity'] +slug: /tools/sdk/python/beta/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'BetaIdentityDeletedIdentity'] +--- + +# 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.beta.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/Beta/Models/IdentityEntities.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityEntities.md new file mode 100644 index 000000000..c6d4f60c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityEntities.md @@ -0,0 +1,36 @@ +--- +id: beta-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntities', 'BetaIdentityEntities'] +slug: /tools/sdk/python/beta/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'BetaIdentityEntities'] +--- + +# IdentityEntities + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_entity** | [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_entities import IdentityEntities + +identity_entities = IdentityEntities( +identity_entity=sailpoint.beta.models.identity_entities_identity_entity.IdentityEntities_identityEntity( + id = '031034e97f094a4096c1be53f75f6b91', + name = 'Gaston.800ddf9640a', + type = 'CAMPAIGN_CAMPAIGNER', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..6ed140c49 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitiesIdentityEntity', 'BetaIdentityEntitiesIdentityEntity'] +slug: /tools/sdk/python/beta/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'BetaIdentityEntitiesIdentityEntity'] +--- + +# IdentityEntitiesIdentityEntity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the resource to which the identity is associated | [optional] +**name** | **str** | name of the resource to which the identity is associated | [optional] +**type** | **str** | type of the resource to which the identity is associated | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_entities_identity_entity import IdentityEntitiesIdentityEntity + +identity_entities_identity_entity = IdentityEntitiesIdentityEntity( +id='031034e97f094a4096c1be53f75f6b91', +name='Gaston.800ddf9640a', +type='CAMPAIGN_CAMPAIGNER' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..9de91385a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityExceptionReportReference.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityExceptionReportReference', 'BetaIdentityExceptionReportReference'] +slug: /tools/sdk/python/beta/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'BetaIdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_result_id** | **str** | Task result ID. | [optional] +**report_name** | **str** | Report name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_exception_report_reference import IdentityExceptionReportReference + +identity_exception_report_reference = IdentityExceptionReportReference( +task_result_id='', +report_name='My annual report' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityExceptionReportReference1.md new file mode 100644 index 000000000..de4afbf9c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityExceptionReportReference1.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-exception-report-reference1 +title: IdentityExceptionReportReference1 +pagination_label: IdentityExceptionReportReference1 +sidebar_label: IdentityExceptionReportReference1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityExceptionReportReference1', 'BetaIdentityExceptionReportReference1'] +slug: /tools/sdk/python/beta/models/identity-exception-report-reference1 +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', 'BetaIdentityExceptionReportReference1'] +--- + +# IdentityExceptionReportReference1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_result_id** | **str** | Task result ID. | [optional] +**report_name** | **str** | Report name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_exception_report_reference1 import IdentityExceptionReportReference1 + +identity_exception_report_reference1 = IdentityExceptionReportReference1( +task_result_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +report_name='My annual report' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityHistoryResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..598b3dd34 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityHistoryResponse.md @@ -0,0 +1,43 @@ +--- +id: beta-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityHistoryResponse', 'BetaIdentityHistoryResponse'] +slug: /tools/sdk/python/beta/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'BetaIdentityHistoryResponse'] +--- + +# IdentityHistoryResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the identity ID | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**snapshot** | **str** | the date when the identity record was created | [optional] +**deleted_date** | **str** | the date when the identity was deleted | [optional] +**access_item_count** | **map[string]int** | A map containing the count of each access item | [optional] +**attributes** | **map[string]object** | A map containing the identity attributes | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse + +identity_history_response = IdentityHistoryResponse( +id='bc693f07e7b645539626c25954c58554', +display_name='Adam Zampa', +snapshot='2007-03-01T13:00:00.000Z', +deleted_date='2007-03-01T13:00:00.000Z', +access_item_count={app=0, role=2, entitlement=4, accessProfile=3, account=1}, +attributes={jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityLifecycleState.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..b34583667 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityLifecycleState.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityLifecycleState', 'BetaIdentityLifecycleState'] +slug: /tools/sdk/python/beta/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'BetaIdentityLifecycleState'] +--- + +# IdentityLifecycleState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state_name** | **str** | The name of the lifecycle state | [required] +**manually_updated** | **bool** | Whether the lifecycle state has been manually or automatically set | [required] +} + +## Example + +```python +from sailpoint.beta.models.identity_lifecycle_state import IdentityLifecycleState + +identity_lifecycle_state = IdentityLifecycleState( +state_name='active', +manually_updated=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityListItem.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityListItem.md new file mode 100644 index 000000000..0591d0076 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityListItem.md @@ -0,0 +1,43 @@ +--- +id: beta-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityListItem', 'BetaIdentityListItem'] +slug: /tools/sdk/python/beta/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'BetaIdentityListItem'] +--- + +# IdentityListItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the identity ID | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**first_name** | **str** | the first name of the identity | [optional] +**last_name** | **str** | the last name of the identity | [optional] +**active** | **bool** | indicates if an identity is active or not | [optional] [default to True] +**deleted_date** | **str** | the date when the identity was deleted | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_list_item import IdentityListItem + +identity_list_item = IdentityListItem( +id='bc693f07e7b645539626c25954c58554', +display_name='Adam Zampa', +first_name='Adam', +last_name='Zampa', +active=True, +deleted_date='2007-03-01T13:00:00.000Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityManagerRef.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityManagerRef.md new file mode 100644 index 000000000..838fb30f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityManagerRef.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityManagerRef', 'BetaIdentityManagerRef'] +slug: /tools/sdk/python/beta/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'BetaIdentityManagerRef'] +--- + +# IdentityManagerRef + +Identity's manager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity's manager | [optional] +**id** | **str** | ID of identity's manager | [optional] +**name** | **str** | Human-readable display name of identity's manager | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_manager_ref import IdentityManagerRef + +identity_manager_ref = IdentityManagerRef( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..b572f449d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityOwnershipAssociationDetails', 'BetaIdentityOwnershipAssociationDetails'] +slug: /tools/sdk/python/beta/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'BetaIdentityOwnershipAssociationDetails'] +--- + +# IdentityOwnershipAssociationDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**association_details** | [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails + +identity_ownership_association_details = IdentityOwnershipAssociationDetails( +association_details=[ + sailpoint.beta.models.identity_ownership_association_details_association_details_inner.IdentityOwnershipAssociationDetails_associationDetails_inner( + association_type = 'ROLE_OWNER', + entities = {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE}, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..88d4c6990 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/python/beta/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + + +## 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.beta.models.identity_ownership_association_details_association_details_inner import IdentityOwnershipAssociationDetailsAssociationDetailsInner + +identity_ownership_association_details_association_details_inner = IdentityOwnershipAssociationDetailsAssociationDetailsInner( +association_type='ROLE_OWNER', +entities={id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..e998ed474 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewRequest.md @@ -0,0 +1,43 @@ +--- +id: beta-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewRequest', 'BetaIdentityPreviewRequest'] +slug: /tools/sdk/python/beta/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'BetaIdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_preview_request import IdentityPreviewRequest + +identity_preview_request = IdentityPreviewRequest( +identity_id='', +identity_attribute_config=sailpoint.beta.models.identity_attribute_config.IdentityAttributeConfig( + enabled = True, + attribute_transforms = [ + sailpoint.beta.models.identity_attribute_transform.IdentityAttributeTransform( + identity_attribute_name = 'email', + transform_definition = sailpoint.beta.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/Beta/Models/IdentityPreviewResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..eca6f8aed --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewResponse.md @@ -0,0 +1,49 @@ +--- +id: beta-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewResponse', 'BetaIdentityPreviewResponse'] +slug: /tools/sdk/python/beta/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'BetaIdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**preview_attributes** | [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_preview_response import IdentityPreviewResponse + +identity_preview_response = IdentityPreviewResponse( +identity=sailpoint.beta.models.identity_preview_response_identity.IdentityPreviewResponse_identity( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ), +preview_attributes=[ + sailpoint.beta.models.identity_attribute_preview.IdentityAttributePreview( + name = 'email', + value = 'email@mail.com', + previous_value = 'oldEmail@mail.com', + error_messages = [ + sailpoint.beta.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/Beta/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..10b629336 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewResponseIdentity', 'BetaIdentityPreviewResponseIdentity'] +slug: /tools/sdk/python/beta/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'BetaIdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +Identity's manager. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity's manager. | [optional] +**id** | **str** | ID of identity's manager. | [optional] +**name** | **str** | Human-readable display name of identity's manager. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_preview_response_identity import IdentityPreviewResponseIdentity + +identity_preview_response_identity = IdentityPreviewResponseIdentity( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile.md new file mode 100644 index 000000000..d2fbafea8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile.md @@ -0,0 +1,73 @@ +--- +id: beta-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfile', 'BetaIdentityProfile'] +slug: /tools/sdk/python/beta/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'BetaIdentityProfile'] +--- + +# IdentityProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | Identity profile's description. | [optional] +**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**priority** | **int** | Identity profile's priority. | [optional] +**authoritative_source** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] +**identity_refresh_required** | **bool** | 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. | [optional] [default to False] +**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**identity_exception_report_reference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to True] +} + +## Example + +```python +from sailpoint.beta.models.identity_profile import IdentityProfile + +identity_profile = IdentityProfile( +id='id12345', +name='aName', +created='2023-01-03T21:16:22.432Z', +modified='2023-01-03T21:16:22.432Z', +description='My custom flat file profile', +owner=sailpoint.beta.models.identity_profile_all_of_owner.IdentityProfile_allOf_owner( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +priority=10, +authoritative_source=sailpoint.beta.models.identity_profile_all_of_authoritative_source.IdentityProfile_allOf_authoritativeSource( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +identity_refresh_required=True, +identity_count=8, +identity_attribute_config=sailpoint.beta.models.identity_attribute_config.IdentityAttributeConfig( + enabled = True, + attribute_transforms = [ + sailpoint.beta.models.identity_attribute_transform.IdentityAttributeTransform( + identity_attribute_name = 'email', + transform_definition = sailpoint.beta.models.transform_definition.TransformDefinition( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ), ) + ], ), +identity_exception_report_reference=sailpoint.beta.models.identity_exception_report_reference.IdentityExceptionReportReference( + task_result_id = '', + report_name = 'My annual report', ), +has_time_based_attr=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1.md new file mode 100644 index 000000000..b4e3f9ffc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1.md @@ -0,0 +1,73 @@ +--- +id: beta-identity-profile1 +title: IdentityProfile1 +pagination_label: IdentityProfile1 +sidebar_label: IdentityProfile1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfile1', 'BetaIdentityProfile1'] +slug: /tools/sdk/python/beta/models/identity-profile1 +tags: ['SDK', 'Software Development Kit', 'IdentityProfile1', 'BetaIdentityProfile1'] +--- + +# IdentityProfile1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | Identity profile's description. | [optional] +**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**priority** | **int** | Identity profile's priority. | [optional] +**authoritative_source** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required] +**identity_refresh_required** | **bool** | 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. | [optional] [default to False] +**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] +**identity_exception_report_reference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] +**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.identity_profile1 import IdentityProfile1 + +identity_profile1 = IdentityProfile1( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +description='My custom flat file profile', +owner=sailpoint.beta.models.identity_profile_all_of_owner.IdentityProfile_allOf_owner( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +priority=10, +authoritative_source=sailpoint.beta.models.identity_profile_1_all_of_authoritative_source.IdentityProfile_1_allOf_authoritativeSource( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +identity_refresh_required=True, +identity_count=8, +identity_attribute_config=sailpoint.beta.models.identity_attribute_config_1.IdentityAttributeConfig_1( + enabled = True, + attribute_transforms = [ + sailpoint.beta.models.identity_attribute_transform_1.IdentityAttributeTransform_1( + identity_attribute_name = 'email', + transform_definition = sailpoint.beta.models.transform_definition_1.TransformDefinition_1( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ), ) + ], ), +identity_exception_report_reference=sailpoint.beta.models.identity_exception_report_reference_1.IdentityExceptionReportReference_1( + task_result_id = '2b838de9-db9b-abcf-e646-d4f274ad4238', + report_name = 'My annual report', ), +has_time_based_attr=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md new file mode 100644 index 000000000..df153d2b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-profile1-all-of-authoritative-source +title: IdentityProfile1AllOfAuthoritativeSource +pagination_label: IdentityProfile1AllOfAuthoritativeSource +sidebar_label: IdentityProfile1AllOfAuthoritativeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfile1AllOfAuthoritativeSource', 'BetaIdentityProfile1AllOfAuthoritativeSource'] +slug: /tools/sdk/python/beta/models/identity-profile1-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSource', 'BetaIdentityProfile1AllOfAuthoritativeSource'] +--- + +# IdentityProfile1AllOfAuthoritativeSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional] +**id** | **str** | Authoritative source's ID. | [optional] +**name** | **str** | Authoritative source's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_profile1_all_of_authoritative_source import IdentityProfile1AllOfAuthoritativeSource + +identity_profile1_all_of_authoritative_source = IdentityProfile1AllOfAuthoritativeSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..4fd58ad59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'BetaIdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/python/beta/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'BetaIdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + +Identity profile's authoritative source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional] +**id** | **str** | Authoritative source's ID. | [optional] +**name** | **str** | Authoritative source's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_profile_all_of_authoritative_source import IdentityProfileAllOfAuthoritativeSource + +identity_profile_all_of_authoritative_source = IdentityProfileAllOfAuthoritativeSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..4bdc94d8c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileAllOfOwner', 'BetaIdentityProfileAllOfOwner'] +slug: /tools/sdk/python/beta/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +Identity profile's owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's object type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_profile_all_of_owner import IdentityProfileAllOfOwner + +identity_profile_all_of_owner = IdentityProfileAllOfOwner( +type='IDENTITY', +id='2c9180835d191a86015d28455b4b232a', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..7fd906edc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityProfileExportedObject.md @@ -0,0 +1,41 @@ +--- +id: beta-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileExportedObject', 'BetaIdentityProfileExportedObject'] +slug: /tools/sdk/python/beta/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'BetaIdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +Identity Profile exported object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Version or object from the target service. | [optional] +**var_self** | [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**object** | [**IdentityProfile1**](identity-profile1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject + +identity_profile_exported_object = IdentityProfileExportedObject( +version=1, +var_self=sailpoint.beta.models.self_import_export_dto.SelfImportExportDto( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +object= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityReference.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityReference.md new file mode 100644 index 000000000..13b18f71b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityReference.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReference', 'BetaIdentityReference'] +slug: /tools/sdk/python/beta/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'BetaIdentityReference'] +--- + +# IdentityReference + +The manager for the identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_reference import IdentityReference + +identity_reference = IdentityReference( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityReferenceWithId.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityReferenceWithId.md new file mode 100644 index 000000000..7cee378e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityReferenceWithId.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-reference-with-id +title: IdentityReferenceWithId +pagination_label: IdentityReferenceWithId +sidebar_label: IdentityReferenceWithId +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReferenceWithId', 'BetaIdentityReferenceWithId'] +slug: /tools/sdk/python/beta/models/identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithId', 'BetaIdentityReferenceWithId'] +--- + +# IdentityReferenceWithId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_reference_with_id import IdentityReferenceWithId + +identity_reference_with_id = IdentityReferenceWithId( +type='IDENTITY', +id='5168015d32f890ca15812c9180835d2e' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..b392f9e7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReferenceWithNameAndEmail', 'BetaIdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/python/beta/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'BetaIdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type can only be IDENTITY. This is read-only. | [optional] +**id** | **str** | Identity ID. | [optional] +**name** | **str** | Identity's human-readable display name. This is read-only. | [optional] +**email** | **str** | Identity's email address. This is read-only. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail + +identity_reference_with_name_and_email = IdentityReferenceWithNameAndEmail( +type='IDENTITY', +id='5168015d32f890ca15812c9180835d2e', +name='Alison Ferguso', +email='alison.ferguso@identitysoon.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..1167bec39 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,33 @@ +--- +id: beta-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySnapshotSummaryResponse', 'BetaIdentitySnapshotSummaryResponse'] +slug: /tools/sdk/python/beta/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'BetaIdentitySnapshotSummaryResponse'] +--- + +# IdentitySnapshotSummaryResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**snapshot** | **str** | the date when the identity record was created | [optional] +} + +## Example + +```python +from sailpoint.beta.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse + +identity_snapshot_summary_response = IdentitySnapshotSummaryResponse( +snapshot='2007-03-01T13:00:00.000Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentitySummary.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySummary.md new file mode 100644 index 000000000..e4f6bb4e6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySummary.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySummary', 'BetaIdentitySummary'] +slug: /tools/sdk/python/beta/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'BetaIdentitySummary'] +--- + +# IdentitySummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of this identity summary | [optional] +**name** | **str** | Human-readable display name of identity | [optional] +**identity_id** | **str** | ID of the identity that this summary represents | [optional] +**completed** | **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.identity_summary import IdentitySummary + +identity_summary = IdentitySummary( +id='ff80818155fe8c080155fe8d925b0316', +name='SailPoint Services', +identity_id='c15b9f5cca5a4e9599eaa0e64fa921bd', +completed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentitySyncJob.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySyncJob.md new file mode 100644 index 000000000..18234e168 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySyncJob.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySyncJob', 'BetaIdentitySyncJob'] +slug: /tools/sdk/python/beta/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'BetaIdentitySyncJob'] +--- + +# IdentitySyncJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Job ID. | [required] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The job status. | [required] +**payload** | [**IdentitySyncPayload**](identity-sync-payload) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.identity_sync_job import IdentitySyncJob + +identity_sync_job = IdentitySyncJob( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +status='IN_PROGRESS', +payload=sailpoint.beta.models.identity_sync_payload.IdentitySyncPayload( + type = 'SYNCHRONIZE_IDENTITY_ATTRIBUTES', + data_json = '{"identityId":"2c918083746f642c01746f990884012a"}', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentitySyncPayload.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..a605839f0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentitySyncPayload.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySyncPayload', 'BetaIdentitySyncPayload'] +slug: /tools/sdk/python/beta/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'BetaIdentitySyncPayload'] +--- + +# IdentitySyncPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Payload type. | [required] +**data_json** | **str** | Payload type. | [required] +} + +## Example + +```python +from sailpoint.beta.models.identity_sync_payload import IdentitySyncPayload + +identity_sync_payload = IdentitySyncPayload( +type='SYNCHRONIZE_IDENTITY_ATTRIBUTES', +data_json='{"identityId":"2c918083746f642c01746f990884012a"}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..fea823796 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md @@ -0,0 +1,36 @@ +--- +id: beta-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess', 'BetaIdentityWithNewAccess'] +slug: /tools/sdk/python/beta/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'BetaIdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +An identity with a set of access to be added + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity id to be checked. | [required] +**access_refs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] +} + +## Example + +```python +from sailpoint.beta.models.identity_with_new_access import IdentityWithNewAccess + +identity_with_new_access = IdentityWithNewAccess( +identity_id='2c91808568c529c60168cca6f90c1313', +access_refs=[{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}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..2eac13589 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'BetaIdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/python/beta/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'BetaIdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +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.beta.models.identity_with_new_access_access_refs_inner import IdentityWithNewAccessAccessRefsInner + +identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( +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/Beta/Models/ImportAccountsRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..c17bbabfc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportAccountsRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportAccountsRequest', 'BetaImportAccountsRequest'] +slug: /tools/sdk/python/beta/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'BetaImportAccountsRequest'] +--- + +# ImportAccountsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | The CSV file containing the source accounts to aggregate. | [optional] +**disable_optimization** | **Enum** [ 'true', 'false' ] | Use this flag to reprocess every account whether or not the data has changed. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_accounts_request import ImportAccountsRequest + +import_accounts_request = ImportAccountsRequest( +file=bytes(b'blah'), +disable_optimization='true' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportAccountsRequest1.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportAccountsRequest1.md new file mode 100644 index 000000000..208beaf46 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportAccountsRequest1.md @@ -0,0 +1,34 @@ +--- +id: beta-import-accounts-request1 +title: ImportAccountsRequest1 +pagination_label: ImportAccountsRequest1 +sidebar_label: ImportAccountsRequest1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportAccountsRequest1', 'BetaImportAccountsRequest1'] +slug: /tools/sdk/python/beta/models/import-accounts-request1 +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest1', 'BetaImportAccountsRequest1'] +--- + +# ImportAccountsRequest1 + +This content type is provided for compatibility with services that don't support multipart/form-data, such as SailPoint Workflows. This content type does not support files, so it can only be used for direct connect sources. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**disable_optimization** | **Enum** [ 'true', 'false' ] | Use this flag to reprocess every account whether or not the data has changed. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_accounts_request1 import ImportAccountsRequest1 + +import_accounts_request1 = ImportAccountsRequest1( +disable_optimization='true' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..3a45500a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportEntitlementsBySourceRequest', 'BetaImportEntitlementsBySourceRequest'] +slug: /tools/sdk/python/beta/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'BetaImportEntitlementsBySourceRequest'] +--- + +# ImportEntitlementsBySourceRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**csv_file** | **bytearray** | The CSV file containing the source entitlements to aggregate. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_entitlements_by_source_request import ImportEntitlementsBySourceRequest + +import_entitlements_by_source_request = ImportEntitlementsBySourceRequest( +csv_file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportEntitlementsRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportEntitlementsRequest.md new file mode 100644 index 000000000..715f635d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportEntitlementsRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-import-entitlements-request +title: ImportEntitlementsRequest +pagination_label: ImportEntitlementsRequest +sidebar_label: ImportEntitlementsRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportEntitlementsRequest', 'BetaImportEntitlementsRequest'] +slug: /tools/sdk/python/beta/models/import-entitlements-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest', 'BetaImportEntitlementsRequest'] +--- + +# ImportEntitlementsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | The CSV file containing the source entitlements to aggregate. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_entitlements_request import ImportEntitlementsRequest + +import_entitlements_request = ImportEntitlementsRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..ff7679920 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,120 @@ +--- +id: beta-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportFormDefinitions202Response', 'BetaImportFormDefinitions202Response'] +slug: /tools/sdk/python/beta/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'BetaImportFormDefinitions202Response'] +--- + +# ImportFormDefinitions202Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**imported_objects** | [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional] +**infos** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**warnings** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_form_definitions202_response import ImportFormDefinitions202Response + +import_form_definitions202_response = ImportFormDefinitions202Response( +errors=[ + sailpoint.beta.models.import_form_definitions_202_response_errors_inner.importFormDefinitions_202_response_errors_inner( + detail = { + 'key' : None + }, + key = '', + text = '', ) + ], +imported_objects=[ + sailpoint.beta.models.export_form_definitions_by_tenant_200_response_inner.exportFormDefinitionsByTenant_200_response_inner( + object = sailpoint.beta.models.form_definition_response.FormDefinitionResponse( + id = '00000000-0000-0000-0000-000000000000', + name = 'My form', + description = 'My form description', + owner = sailpoint.beta.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), + used_by = [ + sailpoint.beta.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], + form_input = [ + sailpoint.beta.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.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], + form_conditions = [ + sailpoint.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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', ), + self = sailpoint.beta.models.form_definition_self_import_export_dto.FormDefinitionSelfImportExportDto( + type = 'FORM_DEFINITION', + id = '2c9180835d191a86015d28455b4b232a', + name = 'Temporary User Level Permissions - Requester', ), + version = 56, ) + ], +infos=[ + sailpoint.beta.models.import_form_definitions_202_response_errors_inner.importFormDefinitions_202_response_errors_inner( + detail = { + 'key' : None + }, + key = '', + text = '', ) + ], +warnings=[ + sailpoint.beta.models.import_form_definitions_202_response_errors_inner.importFormDefinitions_202_response_errors_inner( + detail = { + 'key' : None + }, + key = '', + text = '', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..792944ae5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'BetaImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/python/beta/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'BetaImportFormDefinitions202ResponseErrorsInner'] +--- + +# ImportFormDefinitions202ResponseErrorsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | **map[string]object** | | [optional] +**key** | **str** | | [optional] +**text** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_form_definitions202_response_errors_inner import ImportFormDefinitions202ResponseErrorsInner + +import_form_definitions202_response_errors_inner = ImportFormDefinitions202ResponseErrorsInner( +detail={ + 'key' : None + }, +key='', +text='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitionsRequestInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitionsRequestInner.md new file mode 100644 index 000000000..25de91f72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportFormDefinitionsRequestInner.md @@ -0,0 +1,89 @@ +--- +id: beta-import-form-definitions-request-inner +title: ImportFormDefinitionsRequestInner +pagination_label: ImportFormDefinitionsRequestInner +sidebar_label: ImportFormDefinitionsRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportFormDefinitionsRequestInner', 'BetaImportFormDefinitionsRequestInner'] +slug: /tools/sdk/python/beta/models/import-form-definitions-request-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'BetaImportFormDefinitionsRequestInner'] +--- + +# ImportFormDefinitionsRequestInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | [**FormDefinitionResponse**](form-definition-response) | | [optional] +**var_self** | **str** | | [optional] +**version** | **int** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner + +import_form_definitions_request_inner = ImportFormDefinitionsRequestInner( +object=sailpoint.beta.models.form_definition_response.FormDefinitionResponse( + id = '00000000-0000-0000-0000-000000000000', + name = 'My form', + description = 'My form description', + owner = sailpoint.beta.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), + used_by = [ + sailpoint.beta.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], + form_input = [ + sailpoint.beta.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.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], + form_conditions = [ + sailpoint.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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='', +version=56 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..eff8482ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'BetaImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/python/beta/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'BetaImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | | [required] +} + +## Example + +```python +from sailpoint.beta.models.import_non_employee_records_in_bulk_request import ImportNonEmployeeRecordsInBulkRequest + +import_non_employee_records_in_bulk_request = ImportNonEmployeeRecordsInBulkRequest( +data=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportObject.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportObject.md new file mode 100644 index 000000000..608cf39a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportObject.md @@ -0,0 +1,38 @@ +--- +id: beta-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportObject', 'BetaImportObject'] +slug: /tools/sdk/python/beta/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'BetaImportObject'] +--- + +# ImportObject + +Object created or updated by import. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_RULE', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional] +**id** | **str** | ID of object created or updated by import. | [optional] +**name** | **str** | Display name of object created or updated by import. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_object import ImportObject + +import_object = ImportObject( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportOptions.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportOptions.md new file mode 100644 index 000000000..a0c8d7555 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportOptions.md @@ -0,0 +1,47 @@ +--- +id: beta-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportOptions', 'BetaImportOptions'] +slug: /tools/sdk/python/beta/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'BetaImportOptions'] +--- + +# ImportOptions + + +## 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] +**default_references** | **[]str** | List of object types that can be used to resolve references on import. | [optional] +**exclude_backup** | **bool** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.import_options import ImportOptions + +import_options = ImportOptions( +exclude_types=[ + 'SOURCE' + ], +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}, +default_references=[ + 'TRIGGER_SUBSCRIPTION' + ], +exclude_backup=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ImportSpConfigRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..b18f135e6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ImportSpConfigRequest.md @@ -0,0 +1,46 @@ +--- +id: beta-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportSpConfigRequest', 'BetaImportSpConfigRequest'] +slug: /tools/sdk/python/beta/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'BetaImportSpConfigRequest'] +--- + +# ImportSpConfigRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | JSON file containing the objects to be imported. | [required] +**options** | [**ImportOptions**](import-options) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.import_sp_config_request import ImportSpConfigRequest + +import_sp_config_request = ImportSpConfigRequest( +data=bytes(b'blah'), +options=sailpoint.beta.models.import_options.ImportOptions( + exclude_types = [ + 'SOURCE' + ], + include_types = [ + 'TRIGGER_SUBSCRIPTION' + ], + object_options = {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}, + default_references = [ + 'TRIGGER_SUBSCRIPTION' + ], + exclude_backup = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Index.md b/docs/tools/sdk/python/Reference/Beta/Models/Index.md new file mode 100644 index 000000000..dcfd00a64 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['python', 'Python', 'sdk', 'models'] +slug: /tools/sdk/python/beta/models +tags: ['SDK', 'Software Development Kit', 'beta', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/python/Reference/Beta/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..11e1287cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/InviteIdentitiesRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InviteIdentitiesRequest', 'BetaInviteIdentitiesRequest'] +slug: /tools/sdk/python/beta/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'BetaInviteIdentitiesRequest'] +--- + +# InviteIdentitiesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**uninvited** | **bool** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.invite_identities_request import InviteIdentitiesRequest + +invite_identities_request = InviteIdentitiesRequest( +ids=[2b568c65bc3c4c57a43bd97e3a8e55, 2c9180867769897d01776ed5f125512f], +uninvited=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Invocation.md b/docs/tools/sdk/python/Reference/Beta/Models/Invocation.md new file mode 100644 index 000000000..ca94873ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Invocation.md @@ -0,0 +1,39 @@ +--- +id: beta-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Invocation', 'BetaInvocation'] +slug: /tools/sdk/python/beta/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'BetaInvocation'] +--- + +# Invocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Invocation ID | [optional] +**trigger_id** | **str** | Trigger ID | [optional] +**secret** | **str** | Unique invocation secret. | [optional] +**content_json** | **object** | JSON map of invocation metadata. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.invocation import Invocation + +invocation = Invocation( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +trigger_id='idn:access-requested', +secret='0f979022-08be-44f2-b6f9-7393ec73ed9b', +content_json={workflowId=1234} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/InvocationStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/InvocationStatus.md new file mode 100644 index 000000000..bcf7a9320 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/InvocationStatus.md @@ -0,0 +1,56 @@ +--- +id: beta-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InvocationStatus', 'BetaInvocationStatus'] +slug: /tools/sdk/python/beta/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'BetaInvocationStatus'] +--- + +# InvocationStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Invocation ID | [required] +**trigger_id** | **str** | Trigger ID | [required] +**subscription_name** | **str** | Subscription name | [required] +**subscription_id** | **str** | Subscription ID | [required] +**type** | [**InvocationStatusType**](invocation-status-type) | | [required] +**created** | **datetime** | Invocation created timestamp. ISO-8601 in UTC. | [required] +**completed** | **datetime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**start_invocation_input** | [**StartInvocationInput**](start-invocation-input) | | [required] +**complete_invocation_input** | [**CompleteInvocationInput**](complete-invocation-input) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.invocation_status import InvocationStatus + +invocation_status = InvocationStatus( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +trigger_id='idn:access-request-post-approval', +subscription_name='Access request subscription', +subscription_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +type='TEST', +created='2020-03-27T20:40:10.738Z', +completed='2020-03-27T20:42:14.738Z', +start_invocation_input=sailpoint.beta.models.start_invocation_input.StartInvocationInput( + trigger_id = 'idn:access-requested', + input = {identityId=201327fda1c44704ac01181e963d463c}, + content_json = {workflowId=1234}, ), +complete_invocation_input=sailpoint.beta.models.complete_invocation_input.CompleteInvocationInput( + localized_error = sailpoint.beta.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), + output = {approved=false}, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/InvocationStatusType.md b/docs/tools/sdk/python/Reference/Beta/Models/InvocationStatusType.md new file mode 100644 index 000000000..c3a198c56 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/InvocationStatusType.md @@ -0,0 +1,23 @@ +--- +id: beta-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InvocationStatusType', 'BetaInvocationStatusType'] +slug: /tools/sdk/python/beta/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'BetaInvocationStatusType'] +--- + +# InvocationStatusType + +Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. + +## Enum + +* `TEST` (value: `'TEST'`) + +* `REAL_TIME` (value: `'REAL_TIME'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/JsonPatch.md b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatch.md new file mode 100644 index 000000000..c0b62e829 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatch.md @@ -0,0 +1,39 @@ +--- +id: beta-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatch', 'BetaJsonPatch'] +slug: /tools/sdk/python/beta/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'BetaJsonPatch'] +--- + +# JsonPatch + +A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] +} + +## Example + +```python +from sailpoint.beta.models.json_patch import JsonPatch + +json_patch = JsonPatch( +operations=[ + sailpoint.beta.models.json_patch_operation.JsonPatchOperation( + op = 'replace', + path = '/description', + value = New description, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperation.md b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperation.md new file mode 100644 index 000000000..7f8097b4f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperation.md @@ -0,0 +1,38 @@ +--- +id: beta-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperation', 'BetaJsonPatchOperation'] +slug: /tools/sdk/python/beta/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'BetaJsonPatchOperation'] +--- + +# JsonPatchOperation + +A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy', 'test' ] | The operation to be performed | [required] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + +json_patch_operation = JsonPatchOperation( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperations.md b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperations.md new file mode 100644 index 000000000..676563f3f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperations.md @@ -0,0 +1,38 @@ +--- +id: beta-json-patch-operations +title: JsonPatchOperations +pagination_label: JsonPatchOperations +sidebar_label: JsonPatchOperations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperations', 'BetaJsonPatchOperations'] +slug: /tools/sdk/python/beta/models/json-patch-operations +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperations', 'BetaJsonPatchOperations'] +--- + +# JsonPatchOperations + +A limited JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'remove', 'replace' ] | The operation to be performed | [required] +**path** | **str** | A string representing the target path to an element to be affected by the operation | [required] +**value** | [**JsonPatchOperationsValue**](json-patch-operations-value) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.json_patch_operations import JsonPatchOperations + +json_patch_operations = JsonPatchOperations( +op='replace', +path='/dismissed', +value=true +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperationsValue.md b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperationsValue.md new file mode 100644 index 000000000..1e4289a74 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/JsonPatchOperationsValue.md @@ -0,0 +1,32 @@ +--- +id: beta-json-patch-operations-value +title: JsonPatchOperationsValue +pagination_label: JsonPatchOperationsValue +sidebar_label: JsonPatchOperationsValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperationsValue', 'BetaJsonPatchOperationsValue'] +slug: /tools/sdk/python/beta/models/json-patch-operations-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationsValue', 'BetaJsonPatchOperationsValue'] +--- + +# JsonPatchOperationsValue + +The value to be used for the operation, required for \"add\" and \"replace\" operations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.json_patch_operations_value import JsonPatchOperationsValue + +json_patch_operations_value = JsonPatchOperationsValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/python/Reference/Beta/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..56a6b708b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/KbaAnswerRequestItem.md @@ -0,0 +1,35 @@ +--- +id: beta-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAnswerRequestItem', 'BetaKbaAnswerRequestItem'] +slug: /tools/sdk/python/beta/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'BetaKbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Question Id | [required] +**answer** | **str** | An answer for the KBA question | [required] +} + +## Example + +```python +from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem + +kba_answer_request_item = KbaAnswerRequestItem( +id='c54fee53-2d63-4fc5-9259-3e93b9994135', +answer='Your answer' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/python/Reference/Beta/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..e3ce7abb6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/KbaAnswerResponseItem.md @@ -0,0 +1,37 @@ +--- +id: beta-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAnswerResponseItem', 'BetaKbaAnswerResponseItem'] +slug: /tools/sdk/python/beta/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'BetaKbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Question Id | [required] +**question** | **str** | Question description | [required] +**has_answer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | [required] +} + +## Example + +```python +from sailpoint.beta.models.kba_answer_response_item import KbaAnswerResponseItem + +kba_answer_response_item = KbaAnswerResponseItem( +id='c54fee53-2d63-4fc5-9259-3e93b9994135', +question='[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]', +has_answer=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/KbaAuthResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/KbaAuthResponse.md new file mode 100644 index 000000000..4e7718f91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/KbaAuthResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-kba-auth-response +title: KbaAuthResponse +pagination_label: KbaAuthResponse +sidebar_label: KbaAuthResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAuthResponse', 'BetaKbaAuthResponse'] +slug: /tools/sdk/python/beta/models/kba-auth-response +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse', 'BetaKbaAuthResponse'] +--- + +# KbaAuthResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kba_auth_response_items** | [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] +**status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED', 'LOCKOUT', 'NOT_ENOUGH_DATA' ] | MFA Authentication status | [optional] +} + +## Example + +```python +from sailpoint.beta.models.kba_auth_response import KbaAuthResponse + +kba_auth_response = KbaAuthResponse( +kba_auth_response_items=[{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}], +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/KbaAuthResponseItem.md b/docs/tools/sdk/python/Reference/Beta/Models/KbaAuthResponseItem.md new file mode 100644 index 000000000..30a4741fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/KbaAuthResponseItem.md @@ -0,0 +1,35 @@ +--- +id: beta-kba-auth-response-item +title: KbaAuthResponseItem +pagination_label: KbaAuthResponseItem +sidebar_label: KbaAuthResponseItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAuthResponseItem', 'BetaKbaAuthResponseItem'] +slug: /tools/sdk/python/beta/models/kba-auth-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem', 'BetaKbaAuthResponseItem'] +--- + +# KbaAuthResponseItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question_id** | **str** | The KBA question id | [optional] +**is_verified** | **bool** | Return true if verified | [optional] +} + +## Example + +```python +from sailpoint.beta.models.kba_auth_response_item import KbaAuthResponseItem + +kba_auth_response_item = KbaAuthResponseItem( +question_id='089899f13a8f4da7824996191587bab9', +is_verified=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/KbaQuestion.md b/docs/tools/sdk/python/Reference/Beta/Models/KbaQuestion.md new file mode 100644 index 000000000..e90fabd9d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/KbaQuestion.md @@ -0,0 +1,40 @@ +--- +id: beta-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaQuestion', 'BetaKbaQuestion'] +slug: /tools/sdk/python/beta/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'BetaKbaQuestion'] +--- + +# KbaQuestion + +KBA Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | KBA Question Id | [required] +**text** | **str** | KBA Question description | [required] +**has_answer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] +**num_answers** | **int** | Denotes the number of KBA configurations for this question | [required] +} + +## Example + +```python +from sailpoint.beta.models.kba_question import KbaQuestion + +kba_question = KbaQuestion( +id='143cfd3b-c23f-426b-ae5f-d3db06fa5919', +text='[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]', +has_answer=True, +num_answers=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LatestOutlierSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..b7f9f4690 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LatestOutlierSummary.md @@ -0,0 +1,41 @@ +--- +id: beta-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LatestOutlierSummary', 'BetaLatestOutlierSummary'] +slug: /tools/sdk/python/beta/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'BetaLatestOutlierSummary'] +--- + +# LatestOutlierSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LOW_SIMILARITY', 'STRUCTURAL' ] | The type of outlier summary | [optional] +**snapshot_date** | **datetime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**total_outliers** | **int** | Total number of outliers for the customer making the request | [optional] +**total_identities** | **int** | Total number of identities for the customer making the request | [optional] +**total_ignored** | **int** | Total number of ignored outliers | [optional] +} + +## Example + +```python +from sailpoint.beta.models.latest_outlier_summary import LatestOutlierSummary + +latest_outlier_summary = LatestOutlierSummary( +type='LOW_SIMILARITY', +snapshot_date='2021-05-01T18:40:35.772Z', +total_outliers=50, +total_identities=5000, +total_ignored=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Launcher.md b/docs/tools/sdk/python/Reference/Beta/Models/Launcher.md new file mode 100644 index 000000000..2ce230f93 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Launcher.md @@ -0,0 +1,55 @@ +--- +id: beta-launcher +title: Launcher +pagination_label: Launcher +sidebar_label: Launcher +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Launcher', 'BetaLauncher'] +slug: /tools/sdk/python/beta/models/launcher +tags: ['SDK', 'Software Development Kit', 'Launcher', 'BetaLauncher'] +--- + +# Launcher + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the Launcher | [required] +**created** | **datetime** | Date the Launcher was created | [required] +**modified** | **datetime** | Date the Launcher was last modified | [required] +**owner** | [**LauncherOwner**](launcher-owner) | | [required] +**name** | **str** | Name of the Launcher, limited to 255 characters | [required] +**description** | **str** | Description of the Launcher, limited to 2000 characters | [required] +**type** | **Enum** [ 'INTERACTIVE_PROCESS' ] | Launcher type | [required] +**disabled** | **bool** | State of the Launcher | [required] +**reference** | [**LauncherReference**](launcher-reference) | | [optional] +**config** | **str** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required] +} + +## Example + +```python +from sailpoint.beta.models.launcher import Launcher + +launcher = Launcher( +id='1b630bed-0941-4792-a712-57a5868ca34d', +created='2024-04-16T20:07:30.601016489Z', +modified='2024-04-17T18:02:07.320143194Z', +owner=sailpoint.beta.models.launcher_owner.Launcher_owner( + type = 'IDENTITY', + id = '123180847373330f0173c7e1756b6890', ), +name='Group Create', +description='Create a new Active Directory Group', +type='INTERACTIVE_PROCESS', +disabled=False, +reference=sailpoint.beta.models.launcher_reference.Launcher_reference( + type = 'WORKFLOW', + id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ), +config='{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LauncherOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/LauncherOwner.md new file mode 100644 index 000000000..ce3b9cb10 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LauncherOwner.md @@ -0,0 +1,36 @@ +--- +id: beta-launcher-owner +title: LauncherOwner +pagination_label: LauncherOwner +sidebar_label: LauncherOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LauncherOwner', 'BetaLauncherOwner'] +slug: /tools/sdk/python/beta/models/launcher-owner +tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'BetaLauncherOwner'] +--- + +# LauncherOwner + +Owner of the Launcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Owner type | [required] +**id** | **str** | Owner ID | [required] +} + +## Example + +```python +from sailpoint.beta.models.launcher_owner import LauncherOwner + +launcher_owner = LauncherOwner( +type='IDENTITY', +id='123180847373330f0173c7e1756b6890' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LauncherReference.md b/docs/tools/sdk/python/Reference/Beta/Models/LauncherReference.md new file mode 100644 index 000000000..d37a5e970 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LauncherReference.md @@ -0,0 +1,35 @@ +--- +id: beta-launcher-reference +title: LauncherReference +pagination_label: LauncherReference +sidebar_label: LauncherReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LauncherReference', 'BetaLauncherReference'] +slug: /tools/sdk/python/beta/models/launcher-reference +tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'BetaLauncherReference'] +--- + +# LauncherReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WORKFLOW' ] | Type of Launcher reference | [optional] +**id** | **str** | ID of Launcher reference | [optional] +} + +## Example + +```python +from sailpoint.beta.models.launcher_reference import LauncherReference + +launcher_reference = LauncherReference( +type='WORKFLOW', +id='2fd6ff94-2081-4d29-acbc-83a0a2f744a5' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LauncherRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/LauncherRequest.md new file mode 100644 index 000000000..50dcc89fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LauncherRequest.md @@ -0,0 +1,45 @@ +--- +id: beta-launcher-request +title: LauncherRequest +pagination_label: LauncherRequest +sidebar_label: LauncherRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LauncherRequest', 'BetaLauncherRequest'] +slug: /tools/sdk/python/beta/models/launcher-request +tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'BetaLauncherRequest'] +--- + +# LauncherRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the Launcher, limited to 255 characters | [required] +**description** | **str** | Description of the Launcher, limited to 2000 characters | [required] +**type** | **Enum** [ 'INTERACTIVE_PROCESS' ] | Launcher type | [required] +**disabled** | **bool** | State of the Launcher | [required] +**reference** | [**LauncherRequestReference**](launcher-request-reference) | | [optional] +**config** | **str** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required] +} + +## Example + +```python +from sailpoint.beta.models.launcher_request import LauncherRequest + +launcher_request = LauncherRequest( +name='Group Create', +description='Create a new Active Directory Group', +type='INTERACTIVE_PROCESS', +disabled=False, +reference=sailpoint.beta.models.launcher_request_reference.LauncherRequest_reference( + type = 'WORKFLOW', + id = '2fd6ff94-2081-4d29-acbc-83a0a2f744a5', ), +config='{"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LauncherRequestReference.md b/docs/tools/sdk/python/Reference/Beta/Models/LauncherRequestReference.md new file mode 100644 index 000000000..8b9638c85 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LauncherRequestReference.md @@ -0,0 +1,35 @@ +--- +id: beta-launcher-request-reference +title: LauncherRequestReference +pagination_label: LauncherRequestReference +sidebar_label: LauncherRequestReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LauncherRequestReference', 'BetaLauncherRequestReference'] +slug: /tools/sdk/python/beta/models/launcher-request-reference +tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'BetaLauncherRequestReference'] +--- + +# LauncherRequestReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WORKFLOW' ] | Type of Launcher reference | [required] +**id** | **str** | ID of Launcher reference | [required] +} + +## Example + +```python +from sailpoint.beta.models.launcher_request_reference import LauncherRequestReference + +launcher_request_reference = LauncherRequestReference( +type='WORKFLOW', +id='2fd6ff94-2081-4d29-acbc-83a0a2f744a5' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/License.md b/docs/tools/sdk/python/Reference/Beta/Models/License.md new file mode 100644 index 000000000..bbaa8a4da --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/License.md @@ -0,0 +1,35 @@ +--- +id: beta-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'License', 'BetaLicense'] +slug: /tools/sdk/python/beta/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'BetaLicense'] +--- + +# License + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**license_id** | **str** | Name of the license | [optional] +**legacy_feature_name** | **str** | Legacy name of the license | [optional] +} + +## Example + +```python +from sailpoint.beta.models.license import License + +license = License( +license_id='idn:access-request', +legacy_feature_name='ACCESS_REQUEST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LifecycleState.md b/docs/tools/sdk/python/Reference/Beta/Models/LifecycleState.md new file mode 100644 index 000000000..99c496107 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LifecycleState.md @@ -0,0 +1,61 @@ +--- +id: beta-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecycleState', 'BetaLifecycleState'] +slug: /tools/sdk/python/beta/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'BetaLifecycleState'] +--- + +# LifecycleState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Lifecycle state ID. | [optional] [readonly] +**name** | **str** | Lifecycle state name. | [optional] [readonly] +**technical_name** | **str** | Lifecycle state technical name. This is for internal use. | [optional] [readonly] +**description** | **str** | Lifecycle state description. | [optional] +**created** | **datetime** | Lifecycle state created date. | [optional] [readonly] +**modified** | **datetime** | Lifecycle state modified date. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to False] +**identity_count** | **int** | Number of identities that have the lifecycle state. | [optional] [readonly] +**email_notification_option** | [**EmailNotificationOption**](email-notification-option) | | [optional] +**account_actions** | [**[]AccountAction**](account-action) | | [optional] +**access_profile_ids** | **[]str** | List of access-profile IDs that are associated with the lifecycle state. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.lifecycle_state import LifecycleState + +lifecycle_state = LifecycleState( +id='2c9180835d2e5168015d32f890ca1581', +name='Lifecycle Name', +technical_name='lifecycleTechnicalName', +description='LifecycleDescription', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +enabled=True, +identity_count=12, +email_notification_option=sailpoint.beta.models.email_notification_option.EmailNotificationOption( + notify_managers = True, + notify_all_admins = True, + notify_specific_users = True, + email_address_list = [test@test.com, test2@test.com], ), +account_actions=[ + sailpoint.beta.models.account_action.AccountAction( + action = 'ENABLE', + source_ids = [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], ) + ], +access_profile_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LifecycleStateDto.md b/docs/tools/sdk/python/Reference/Beta/Models/LifecycleStateDto.md new file mode 100644 index 000000000..8356a83b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LifecycleStateDto.md @@ -0,0 +1,35 @@ +--- +id: beta-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecycleStateDto', 'BetaLifecycleStateDto'] +slug: /tools/sdk/python/beta/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'BetaLifecycleStateDto'] +--- + +# LifecycleStateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state_name** | **str** | The name of the lifecycle state | [required] +**manually_updated** | **bool** | Whether the lifecycle state has been manually or automatically set | [required] +} + +## Example + +```python +from sailpoint.beta.models.lifecycle_state_dto import LifecycleStateDto + +lifecycle_state_dto = LifecycleStateDto( +state_name='active', +manually_updated=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListAccessModelMetadataAttribute401Response.md b/docs/tools/sdk/python/Reference/Beta/Models/ListAccessModelMetadataAttribute401Response.md new file mode 100644 index 000000000..b89976b02 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListAccessModelMetadataAttribute401Response.md @@ -0,0 +1,33 @@ +--- +id: beta-list-access-model-metadata-attribute401-response +title: ListAccessModelMetadataAttribute401Response +pagination_label: ListAccessModelMetadataAttribute401Response +sidebar_label: ListAccessModelMetadataAttribute401Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListAccessModelMetadataAttribute401Response', 'BetaListAccessModelMetadataAttribute401Response'] +slug: /tools/sdk/python/beta/models/list-access-model-metadata-attribute401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute401Response', 'BetaListAccessModelMetadataAttribute401Response'] +--- + +# ListAccessModelMetadataAttribute401Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_access_model_metadata_attribute401_response import ListAccessModelMetadataAttribute401Response + +list_access_model_metadata_attribute401_response = ListAccessModelMetadataAttribute401Response( +error=JWT validation failed: JWT is expired +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListAccessModelMetadataAttribute429Response.md b/docs/tools/sdk/python/Reference/Beta/Models/ListAccessModelMetadataAttribute429Response.md new file mode 100644 index 000000000..007899745 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListAccessModelMetadataAttribute429Response.md @@ -0,0 +1,33 @@ +--- +id: beta-list-access-model-metadata-attribute429-response +title: ListAccessModelMetadataAttribute429Response +pagination_label: ListAccessModelMetadataAttribute429Response +sidebar_label: ListAccessModelMetadataAttribute429Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListAccessModelMetadataAttribute429Response', 'BetaListAccessModelMetadataAttribute429Response'] +slug: /tools/sdk/python/beta/models/list-access-model-metadata-attribute429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute429Response', 'BetaListAccessModelMetadataAttribute429Response'] +--- + +# ListAccessModelMetadataAttribute429Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_access_model_metadata_attribute429_response import ListAccessModelMetadataAttribute429Response + +list_access_model_metadata_attribute429_response = ListAccessModelMetadataAttribute429Response( +message= Rate Limit Exceeded +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..e97036cb3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,57 @@ +--- +id: beta-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'BetaListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/python/beta/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'BetaListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Operator ID. | [optional] +**name** | **str** | Operator friendly name | [optional] +**type** | **str** | Operator type | [optional] +**description** | **str** | Description of the operator | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**example_output** | [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**version_number** | **int** | Version number | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**output_schema** | **object** | Example output schema | [optional] +**input_example** | **object** | Example trigger payload if applicable | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + +list_complete_workflow_library200_response_inner = ListCompleteWorkflowLibrary200ResponseInner( +id='sp:compare-boolean', +name='Compare Boolean Values', +type='OPERATOR', +description='Compare two boolean values and decide what happens based on the result.', +form_fields=[{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}], +example_output=, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +version_number=56, +is_simulation_enabled=True, +is_dynamic_schema=False, +output_schema=sailpoint.beta.models.output_schema.outputSchema(), +input_example={changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..2b5ce8939 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,89 @@ +--- +id: beta-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListFormDefinitionsByTenantResponse', 'BetaListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/python/beta/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'BetaListFormDefinitionsByTenantResponse'] +--- + +# ListFormDefinitionsByTenantResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Count number of results. | [optional] +**results** | [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse + +list_form_definitions_by_tenant_response = ListFormDefinitionsByTenantResponse( +count=1, +results=[ + sailpoint.beta.models.form_definition_response.FormDefinitionResponse( + id = '00000000-0000-0000-0000-000000000000', + name = 'My form', + description = 'My form description', + owner = sailpoint.beta.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), + used_by = [ + sailpoint.beta.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], + form_input = [ + sailpoint.beta.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.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], + form_conditions = [ + sailpoint.beta.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.beta.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.beta.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.beta.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/Beta/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..fdfc6c177 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,33 @@ +--- +id: beta-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListFormElementDataByElementIDResponse', 'BetaListFormElementDataByElementIDResponse'] +slug: /tools/sdk/python/beta/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'BetaListFormElementDataByElementIDResponse'] +--- + +# ListFormElementDataByElementIDResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse + +list_form_element_data_by_element_id_response = ListFormElementDataByElementIDResponse( +results={"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"}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..3619377b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,69 @@ +--- +id: beta-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'BetaListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/python/beta/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'BetaListIdentityAccessItems200ResponseInner'] +--- + +# ListIdentityAccessItems200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. role in this case | [optional] +**id** | **str** | the access item id | [optional] +**name** | **str** | the access profile name | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the role | [optional] +**display_name** | **str** | the role display name | [optional] +**entitlement_count** | **str** | the number of entitlements the account will create | [optional] +**app_display_name** | **str** | the name of | [optional] +**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional] +**standalone** | **bool** | indicates whether the entitlement is standalone | [required] +**revocable** | **bool** | indicates whether the role is revocable | [required] +**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] +**app_role_id** | **str** | the app role id | [optional] +**attribute** | **str** | the entitlement attribute | [optional] +**value** | **str** | the associated value | [optional] +**entitlement_type** | **str** | the type of entitlement | [optional] +**privileged** | **bool** | indicates whether the entitlement is privileged | [required] +**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required] +} + +## Example + +```python +from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner + +list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner( +access_type='role', +id='2c918087763e69d901763e72e97f006f', +name='sample', +source_name='Source Name', +source_id='2793o32dwd', +description='Role - Workday/Citizenship access', +display_name='sample', +entitlement_count='12', +app_display_name='AppName', +remove_date='2024-07-01T06:00:00.00Z', +standalone=True, +revocable=True, +native_identity='dr.arden.ogahn.d', +app_role_id='2c918087763e69d901763e72e97f006f', +attribute='groups', +value='Upward mobility access', +entitlement_type='entitlement', +privileged=False, +cloud_governed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..b5ae18f95 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListPredefinedSelectOptionsResponse', 'BetaListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/python/beta/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'BetaListPredefinedSelectOptionsResponse'] +--- + +# ListPredefinedSelectOptionsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | **[]str** | Results holds a list of PreDefinedSelectOption items | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse + +list_predefined_select_options_response = ListPredefinedSelectOptionsResponse( +results=[ + 'IDENTITY' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..791cddcb0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,40 @@ +--- +id: beta-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'BetaListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/python/beta/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'BetaListWorkgroupMembers200ResponseInner'] +--- + +# ListWorkgroupMembers200ResponseInner + +Identity of workgroup member. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Workgroup member identity DTO type. | [optional] +**id** | **str** | Workgroup member identity ID. | [optional] +**name** | **str** | Workgroup member identity display name. | [optional] +**email** | **str** | Workgroup member identity email. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner + +list_workgroup_members200_response_inner = ListWorkgroupMembers200ResponseInner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels', +email='michael.michaels@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTask.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTask.md new file mode 100644 index 000000000..1b68c1690 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTask.md @@ -0,0 +1,53 @@ +--- +id: beta-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTask', 'BetaLoadAccountsTask'] +slug: /tools/sdk/python/beta/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'BetaLoadAccountsTask'] +--- + +# LoadAccountsTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | The status of the result | [optional] [default to True] +**task** | [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_accounts_task import LoadAccountsTask + +load_accounts_task = LoadAccountsTask( +success=True, +task=sailpoint.beta.models.load_accounts_task_task.LoadAccountsTask_task( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'QUARTZ', + name = 'Cloud Account Aggregation', + description = 'Aggregate from the specified application', + launcher = 'John Doe', + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + launched = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completed = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completion_status = 'Success', + parent_name = 'Audit Report', + messages = [], + progress = 'Initializing...', + attributes = { + 'key' : None + }, + returns = [ + [{displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED, attributeName=optimizedAggregation}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IGNORED, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED, attributeName=groupsCreated}] + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..ce842875b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTask.md @@ -0,0 +1,63 @@ +--- +id: beta-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTask', 'BetaLoadAccountsTaskTask'] +slug: /tools/sdk/python/beta/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'BetaLoadAccountsTaskTask'] +--- + +# LoadAccountsTaskTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this taskStatus represents | [optional] +**type** | **str** | Type of task this task represents | [optional] +**name** | **str** | The name of the aggregation process | [optional] +**description** | **str** | The description of the task | [optional] +**launcher** | **str** | The user who initiated the task | [optional] +**created** | **datetime** | The Task creation date | [optional] +**launched** | **datetime** | The task start date | [optional] +**completed** | **datetime** | The task completion date | [optional] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Task completion status. | [optional] +**parent_name** | **str** | Name of the parent task if exists. | [optional] +**messages** | [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**progress** | **str** | Current task state. | [optional] +**attributes** | [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**returns** | [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_accounts_task_task import LoadAccountsTaskTask + +load_accounts_task_task = LoadAccountsTaskTask( +id='ef38f94347e94562b5bb8424a56397d8', +type='QUARTZ', +name='Cloud Account Aggregation', +description='Aggregate from the specified application', +launcher='John Doe', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success', +parent_name='Audit Report', +messages=[], +progress='Initializing...', +attributes={ + 'key' : None + }, +returns=[ + [{displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED, attributeName=optimizedAggregation}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IGNORED, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED, attributeName=groupsCreated}] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..9cf3e3dc2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,36 @@ +--- +id: beta-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTaskAttributes', 'BetaLoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/python/beta/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'BetaLoadAccountsTaskTaskAttributes'] +--- + +# LoadAccountsTaskTaskAttributes + +Extra attributes map(dictionary) for the task. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_id** | **str** | The id of the source | [optional] +**optimized_aggregation** | **str** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_accounts_task_task_attributes import LoadAccountsTaskTaskAttributes + +load_accounts_task_task_attributes = LoadAccountsTaskTaskAttributes( +app_id='c31386cb18bb403cbb6df4c86294ff82', +optimized_aggregation='enabled' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..e55c5bb55 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,41 @@ +--- +id: beta-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'BetaLoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/python/beta/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'BetaLoadAccountsTaskTaskMessagesInner'] +--- + +# LoadAccountsTaskTaskMessagesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message. | [optional] +**error** | **bool** | Flag whether message is an error. | [optional] [default to False] +**warning** | **bool** | Flag whether message is a warning. | [optional] [default to False] +**key** | **str** | Message string identifier. | [optional] +**localized_text** | **str** | Message context with the locale based language. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_accounts_task_task_messages_inner import LoadAccountsTaskTaskMessagesInner + +load_accounts_task_task_messages_inner = LoadAccountsTaskTaskMessagesInner( +type='WARN', +error=False, +warning=True, +key='This aggregation failed because the currently running aggregation must complete before the next one can start.', +localized_text='This aggregation failed because the currently running aggregation must complete before the next one can start.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..9012bb27e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,35 @@ +--- +id: beta-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'BetaLoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/python/beta/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'BetaLoadAccountsTaskTaskReturnsInner'] +--- + +# LoadAccountsTaskTaskReturnsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_label** | **str** | The display label of the return value | [optional] +**attribute_name** | **str** | The attribute name of the return value | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_accounts_task_task_returns_inner import LoadAccountsTaskTaskReturnsInner + +load_accounts_task_task_returns_inner = LoadAccountsTaskTaskReturnsInner( +display_label='TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS', +attribute_name='applications' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadEntitlementTask.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..70c3e0e11 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadEntitlementTask.md @@ -0,0 +1,45 @@ +--- +id: beta-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadEntitlementTask', 'BetaLoadEntitlementTask'] +slug: /tools/sdk/python/beta/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'BetaLoadEntitlementTask'] +--- + +# LoadEntitlementTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this taskStatus represents | [optional] +**type** | **str** | Type of task this task represents | [optional] +**unique_name** | **str** | The name of the task | [optional] +**description** | **str** | The description of the task | [optional] +**launcher** | **str** | The user who initiated the task | [optional] +**created** | **datetime** | The creation date of the task | [optional] +**returns** | [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask + +load_entitlement_task = LoadEntitlementTask( +id='ef38f94347e94562b5bb8424a56397d8', +type='QUARTZ', +unique_name='Cloud Group Aggregation', +description='Aggregate from the specified application', +launcher='John Doe', +created='2020-07-11T21:23:15Z', +returns=[{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..ed78b3f00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,35 @@ +--- +id: beta-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadEntitlementTaskReturnsInner', 'BetaLoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/python/beta/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'BetaLoadEntitlementTaskReturnsInner'] +--- + +# LoadEntitlementTaskReturnsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_label** | **str** | The display label for the return value | [optional] +**attribute_name** | **str** | The attribute name for the return value | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_entitlement_task_returns_inner import LoadEntitlementTaskReturnsInner + +load_entitlement_task_returns_inner = LoadEntitlementTaskReturnsInner( +display_label='TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS', +attribute_name='applications' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..199199d9b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,51 @@ +--- +id: beta-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTask', 'BetaLoadUncorrelatedAccountsTask'] +slug: /tools/sdk/python/beta/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'BetaLoadUncorrelatedAccountsTask'] +--- + +# LoadUncorrelatedAccountsTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | The status of the result | [optional] [default to True] +**task** | [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask + +load_uncorrelated_accounts_task = LoadUncorrelatedAccountsTask( +success=True, +task=sailpoint.beta.models.load_uncorrelated_accounts_task_task.LoadUncorrelatedAccountsTask_task( + id = '90b83a6bb737489494794f84cd3a51e6', + type = 'QUARTZ', + name = 'Cloud Process Uncorrelated Accounts', + description = 'Processes uncorrelated accounts for the specified application.', + launcher = 'John Doe', + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + launched = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completed = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completion_status = 'Success', + parent_name = 'Audit Report', + messages = [], + progress = 'Initializing...', + attributes = sailpoint.beta.models.load_uncorrelated_accounts_task_task_attributes.LoadUncorrelatedAccountsTask_task_attributes( + qpoc_job_id = '5d303d46-fc51-48cd-9c6d-4e211e3ab63c', + task_start_delay = sailpoint.beta.models.task_start_delay.taskStartDelay(), ), + returns = [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..571ad5f96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,61 @@ +--- +id: beta-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'BetaLoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/python/beta/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'BetaLoadUncorrelatedAccountsTaskTask'] +--- + +# LoadUncorrelatedAccountsTaskTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this taskStatus represents | [optional] +**type** | **str** | Type of task this task represents | [optional] +**name** | **str** | The name of uncorrelated accounts process | [optional] +**description** | **str** | The description of the task | [optional] +**launcher** | **str** | The user who initiated the task | [optional] +**created** | **datetime** | The Task creation date | [optional] +**launched** | **datetime** | The task start date | [optional] +**completed** | **datetime** | The task completion date | [optional] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Task completion status. | [optional] +**parent_name** | **str** | Name of the parent task if exists. | [optional] +**messages** | [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**progress** | **str** | Current task state. | [optional] +**attributes** | [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**returns** | **object** | Return values from the task | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_uncorrelated_accounts_task_task import LoadUncorrelatedAccountsTaskTask + +load_uncorrelated_accounts_task_task = LoadUncorrelatedAccountsTaskTask( +id='90b83a6bb737489494794f84cd3a51e6', +type='QUARTZ', +name='Cloud Process Uncorrelated Accounts', +description='Processes uncorrelated accounts for the specified application.', +launcher='John Doe', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success', +parent_name='Audit Report', +messages=[], +progress='Initializing...', +attributes=sailpoint.beta.models.load_uncorrelated_accounts_task_task_attributes.LoadUncorrelatedAccountsTask_task_attributes( + qpoc_job_id = '5d303d46-fc51-48cd-9c6d-4e211e3ab63c', + task_start_delay = sailpoint.beta.models.task_start_delay.taskStartDelay(), ), +returns=[{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..54a5bb1fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,36 @@ +--- +id: beta-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'BetaLoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/python/beta/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'BetaLoadUncorrelatedAccountsTaskTaskAttributes'] +--- + +# LoadUncorrelatedAccountsTaskTaskAttributes + +Extra attributes map(dictionary) for the task. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**qpoc_job_id** | **str** | The id of qpoc job | [optional] +**task_start_delay** | **object** | the task start delay value | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_uncorrelated_accounts_task_task_attributes import LoadUncorrelatedAccountsTaskTaskAttributes + +load_uncorrelated_accounts_task_task_attributes = LoadUncorrelatedAccountsTaskTaskAttributes( +qpoc_job_id='5d303d46-fc51-48cd-9c6d-4e211e3ab63c', +task_start_delay=sailpoint.beta.models.task_start_delay.taskStartDelay() +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..1d8435832 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,41 @@ +--- +id: beta-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'BetaLoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/python/beta/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'BetaLoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message. | [optional] +**error** | **bool** | Flag whether message is an error. | [optional] [default to False] +**warning** | **bool** | Flag whether message is a warning. | [optional] [default to False] +**key** | **str** | Message string identifier. | [optional] +**localized_text** | **str** | Message context with the locale based language. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.load_uncorrelated_accounts_task_task_messages_inner import LoadUncorrelatedAccountsTaskTaskMessagesInner + +load_uncorrelated_accounts_task_task_messages_inner = LoadUncorrelatedAccountsTaskTaskMessagesInner( +type='WARN', +error=False, +warning=True, +key='This correlation failed because the currently running correlation must complete before the next one can start.', +localized_text='This correlation failed because the currently running correlation must complete before the next one can start.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LocaleOrigin.md b/docs/tools/sdk/python/Reference/Beta/Models/LocaleOrigin.md new file mode 100644 index 000000000..4ec9c2278 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LocaleOrigin.md @@ -0,0 +1,23 @@ +--- +id: beta-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LocaleOrigin', 'BetaLocaleOrigin'] +slug: /tools/sdk/python/beta/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'BetaLocaleOrigin'] +--- + +# LocaleOrigin + +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. + +## Enum + +* `DEFAULT` (value: `'DEFAULT'`) + +* `REQUEST` (value: `'REQUEST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LocalizedMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/LocalizedMessage.md new file mode 100644 index 000000000..e41561489 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LocalizedMessage.md @@ -0,0 +1,36 @@ +--- +id: beta-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LocalizedMessage', 'BetaLocalizedMessage'] +slug: /tools/sdk/python/beta/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'BetaLocalizedMessage'] +--- + +# LocalizedMessage + +Localized error message to indicate a failed invocation or error if any. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | Message locale | [required] +**message** | **str** | Message text | [required] +} + +## Example + +```python +from sailpoint.beta.models.localized_message import LocalizedMessage + +localized_message = LocalizedMessage( +locale='An error has occurred!', +message='Error has occurred!' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/LookupStep.md b/docs/tools/sdk/python/Reference/Beta/Models/LookupStep.md new file mode 100644 index 000000000..2e1c9494a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/LookupStep.md @@ -0,0 +1,38 @@ +--- +id: beta-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LookupStep', 'BetaLookupStep'] +slug: /tools/sdk/python/beta/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'BetaLookupStep'] +--- + +# LookupStep + +The definition of an Identity according to the Reassignment Configuration service + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassigned_to_id** | **str** | The ID of the Identity who work is reassigned to | [optional] +**reassigned_from_id** | **str** | The ID of the Identity who work is reassigned from | [optional] +**reassignment_type** | [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.lookup_step import LookupStep + +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/Beta/Models/MailFromAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/MailFromAttributes.md new file mode 100644 index 000000000..b352f2df3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MailFromAttributes.md @@ -0,0 +1,42 @@ +--- +id: beta-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MailFromAttributes', 'BetaMailFromAttributes'] +slug: /tools/sdk/python/beta/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'BetaMailFromAttributes'] +--- + +# MailFromAttributes + +MAIL FROM attributes for a domain / identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **str** | The email identity | [optional] +**mail_from_domain** | **str** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**mx_record** | **str** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**txt_record** | **str** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**mail_from_domain_status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED' ] | The current status of the MAIL FROM verification | [optional] +} + +## Example + +```python +from sailpoint.beta.models.mail_from_attributes import MailFromAttributes + +mail_from_attributes = MailFromAttributes( +identity='bob.smith@sailpoint.com', +mail_from_domain='foo.sailpoint.com', +mx_record='10 feedback-smtp.us-east-1.amazonses.com', +txt_record='v=spf1 include:amazonses.com ~all', +mail_from_domain_status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MailFromAttributesDto.md b/docs/tools/sdk/python/Reference/Beta/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..72124f751 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MailFromAttributesDto.md @@ -0,0 +1,36 @@ +--- +id: beta-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MailFromAttributesDto', 'BetaMailFromAttributesDto'] +slug: /tools/sdk/python/beta/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'BetaMailFromAttributesDto'] +--- + +# MailFromAttributesDto + +MAIL FROM attributes for a domain / identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **str** | The identity or domain address | [optional] +**mail_from_domain** | **str** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.mail_from_attributes_dto import MailFromAttributesDto + +mail_from_attributes_dto = MailFromAttributesDto( +identity='BobSmith@sailpoint.com', +mail_from_domain='example.sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClient.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClient.md new file mode 100644 index 000000000..687e2ddc5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClient.md @@ -0,0 +1,66 @@ +--- +id: beta-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClient', 'BetaManagedClient'] +slug: /tools/sdk/python/beta/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'BetaManagedClient'] +--- + +# ManagedClient + +Managed Client + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ManagedClient ID | [optional] [readonly] +**alert_key** | **str** | ManagedClient alert key | [optional] [readonly] +**api_gateway_base_url** | **str** | ManagedClient gateway base url | [optional] [readonly] +**cc_id** | **int** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**client_id** | **str** | The client ID used in API management | [required] +**cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] +**cookbook** | **str** | VA cookbook | [optional] [readonly] +**description** | **str** | ManagedClient description | [required] +**ip_address** | **str** | The public IP address of the ManagedClient | [optional] [readonly] +**last_seen** | **datetime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**name** | **str** | ManagedClient name | [optional] +**since_last_seen** | **str** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | Status of the ManagedClient | [optional] [readonly] +**type** | **str** | Type of the ManagedClient (VA, CCG) | [required] +**va_download_url** | **str** | ManagedClient VA download URL | [optional] [readonly] +**va_version** | **str** | Version that the ManagedClient's VA is running | [optional] [readonly] +**secret** | **str** | Client's apiKey | [optional] +} + +## Example + +```python +from sailpoint.beta.models.managed_client import ManagedClient + +managed_client = ManagedClient( +id='aClientId', +alert_key='anAlertKey', +api_gateway_base_url='https://denali-xxx.api.cloud.sailpoint.com', +cc_id=2248, +client_id='aClientApiId', +cluster_id='aClusterId', +cookbook='va-cookbook-info', +description='A short description of the ManagedClient', +ip_address='123.456.78.90', +last_seen='2020-01-01T00:00Z', +name='aName', +since_last_seen='15000', +status='NORMAL', +type='VA', +va_download_url='aUrl', +va_version='va-megapod-useast1-610-1621372012', +secret='ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatus.md new file mode 100644 index 000000000..d4f3661e7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatus.md @@ -0,0 +1,40 @@ +--- +id: beta-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatus', 'BetaManagedClientStatus'] +slug: /tools/sdk/python/beta/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'BetaManagedClientStatus'] +--- + +# ManagedClientStatus + +Managed Client Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | **object** | ManagedClientStatus body information | [required] +**status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | [required] +**type** | [**ManagedClientType**](managed-client-type) | | [required] +**timestamp** | **datetime** | timestamp on the Client Status update | [required] +} + +## Example + +```python +from sailpoint.beta.models.managed_client_status import ManagedClientStatus + +managed_client_status = ManagedClientStatus( +body={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='NORMAL', +type='CCG', +timestamp='2020-01-01T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatusAggResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatusAggResponse.md new file mode 100644 index 000000000..d8d97a56d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatusAggResponse.md @@ -0,0 +1,40 @@ +--- +id: beta-managed-client-status-agg-response +title: ManagedClientStatusAggResponse +pagination_label: ManagedClientStatusAggResponse +sidebar_label: ManagedClientStatusAggResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatusAggResponse', 'BetaManagedClientStatusAggResponse'] +slug: /tools/sdk/python/beta/models/managed-client-status-agg-response +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusAggResponse', 'BetaManagedClientStatusAggResponse'] +--- + +# ManagedClientStatusAggResponse + +Managed Client Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | **object** | ManagedClientStatus body information | [required] +**status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | [required] +**type** | [**ManagedClientType**](managed-client-type) | | [required] +**timestamp** | **datetime** | timestamp on the Client Status update | [required] +} + +## Example + +```python +from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse + +managed_client_status_agg_response = ManagedClientStatusAggResponse( +body={body={id=1528, clientId=1528, clusterId=1533, orgType=test, vaDownloadUrl=https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip, clusterJobCount=1, configuration={clusterType=sqsCluster, clusterExternalId=2c91808876dd79120176f758af765c58, debug=false, failureThreshold=0, gmtOffset=-6, scheduleUpgrade=false, va_version=va-megapod-useast1-595-1627543540, jobType=VA_UPGRADE, cookbook=va-megapod-useast1-595-1627543540}, connectorServices=[{id=540696, name=EndToEnd-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540698, name=EndToEnd-AzureADSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=null}, {id=540710, name=EndToEnd-OpenLDAP, connector_host=10.0.2.64, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540713, name=Dynamic-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540716, name=EndToEnd-JdbcADSource, connector_host=10.0.5.187, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540717, name=EndToEnd-JdbcSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=[{serviceId=540717, date=2021-02-05T22:58:15Z, file=temp7081703651350031905mysql-connector-java-8.0.11.jar}]}], jobs=[{uuid=872b622f-5ab5-4836-9172-e3bb77f05b2c, cookbook=872b622f-5ab5-4836-9172-e3bb77f05b2c, state=FINISHED, type=VA_UPGRADE, targetId=1528, managedProcessConfiguration={charon={version=345, path=sailpoint/charon, description=null, dependencies=null}, ccg={version=415_583_79.0.0, path=sailpoint/ccg, description=null, dependencies=null}, toolbox={version=6, path=sailpoint/toolbox, description=null, dependencies=null}, fluent={version=50, path=fluent/va, description=null, dependencies=null}, va_agent={version=89, path=sailpoint/va_agent, description=null, dependencies=null}}}], queue={name=megapod-useast1-denali-lwt-cluster-1533, region=us-east-1}, maintenance={window=true, windowStartTime=2021-07-29T00:00:00Z, windowClusterTime=2021-07-29T01:35:24Z, windowFinishTime=2021-07-29T04:00:00Z}}}, +status='NORMAL', +type='CCG', +timestamp='2020-01-01T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatusEnum.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatusEnum.md new file mode 100644 index 000000000..c6a6ced0d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientStatusEnum.md @@ -0,0 +1,32 @@ +--- +id: beta-managed-client-status-enum +title: ManagedClientStatusEnum +pagination_label: ManagedClientStatusEnum +sidebar_label: ManagedClientStatusEnum +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatusEnum', 'BetaManagedClientStatusEnum'] +slug: /tools/sdk/python/beta/models/managed-client-status-enum +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusEnum', 'BetaManagedClientStatusEnum'] +--- + +# ManagedClientStatusEnum + + +## Enum + +* `NORMAL` (value: `'NORMAL'`) + +* `UNDEFINED` (value: `'UNDEFINED'`) + +* `NOT_CONFIGURED` (value: `'NOT_CONFIGURED'`) + +* `CONFIGURING` (value: `'CONFIGURING'`) + +* `WARNING` (value: `'WARNING'`) + +* `ERROR` (value: `'ERROR'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientType.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientType.md new file mode 100644 index 000000000..768e6f7f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClientType.md @@ -0,0 +1,27 @@ +--- +id: beta-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientType', 'BetaManagedClientType'] +slug: /tools/sdk/python/beta/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'BetaManagedClientType'] +--- + +# ManagedClientType + +Managed Client type + +## Enum + +* `CCG` (value: `'CCG'`) + +* `VA` (value: `'VA'`) + +* `INTERNAL` (value: `'INTERNAL'`) + +* `IIQ_HARVESTER` (value: `'IIQ_HARVESTER'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedCluster.md new file mode 100644 index 000000000..023ec7e2a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedCluster.md @@ -0,0 +1,96 @@ +--- +id: beta-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedCluster', 'BetaManagedCluster'] +slug: /tools/sdk/python/beta/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'BetaManagedCluster'] +--- + +# ManagedCluster + +Managed Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ManagedCluster ID | [required] +**name** | **str** | ManagedCluster name | [optional] +**pod** | **str** | ManagedCluster pod | [optional] +**org** | **str** | ManagedCluster org | [optional] +**type** | [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**configuration** | **map[string]str** | ManagedProcess configuration map | [optional] +**key_pair** | [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**attributes** | [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**description** | **str** | ManagedCluster description | [optional] +**redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**client_type** | [**ManagedClientType**](managed-client-type) | | [required] +**ccg_version** | **str** | CCG version used by the ManagedCluster | [required] +**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False] +**log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional] +**operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False] +**status** | **str** | Cluster status | [optional] +**public_key_certificate** | **str** | Public key certificate | [optional] +**public_key_thumbprint** | **str** | Public key thumbprint | [optional] +**public_key** | **str** | Public key | [optional] +**alert_key** | **str** | Key describing any immediate cluster alerts | [optional] +**client_ids** | **[]str** | List of clients in a cluster | [optional] +**service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0] +**cc_id** | **str** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to '0'] +**created_at** | **datetime** | The date/time this cluster was created | [optional] +**updated_at** | **datetime** | The date/time this cluster was last updated | [optional] +} + +## Example + +```python +from sailpoint.beta.models.managed_cluster import ManagedCluster + +managed_cluster = ManagedCluster( +id='aClusterId', +name='Managed Cluster Name', +pod='megapod-useast1', +org='denali', +type='idn', +configuration={clusterExternalId=externalId, ccgVersion=77.0.0}, +key_pair=sailpoint.beta.models.managed_cluster_key_pair.ManagedClusterKeyPair( + public_key = '-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----', + public_key_thumbprint = '6CMlaJIV44-xJxcB3CJBjDUUn54', + public_key_certificate = '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', ), +attributes=sailpoint.beta.models.managed_cluster_attributes.ManagedClusterAttributes( + queue = sailpoint.beta.models.managed_cluster_queue.ManagedClusterQueue( + name = 'megapod-useast1-denali-lwt-cluster-1533', + region = 'us-east-1', ), + keystore = '/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW', ), +description='A short description of the managed cluster.', +redis=sailpoint.beta.models.managed_cluster_redis.ManagedClusterRedis( + redis_host = 'megapod-useast1-shared-redis.cloud.sailpoint.com', + redis_port = 6379, ), +client_type='CCG', +ccg_version='v01', +pinned_config=False, +log_configuration=sailpoint.beta.models.client_log_configuration.ClientLogConfiguration( + client_id = 'aClientId', + duration_minutes = 120, + expiration = '2020-12-15T19:13:36.079Z', + root_level = 'INFO', + log_levels = INFO, ), +operational=False, +status='NORMAL', +public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----', +public_key_thumbprint='obc6pLiulGbtZ', +public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----', +alert_key='LIMITED_RESOURCES', +client_ids=[1244, 1245], +service_count=6, +cc_id='0', +created_at='2023-08-04T20:48:01.865Z', +updated_at='2023-08-04T20:48:01.865Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..4551f3b60 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterAttributes.md @@ -0,0 +1,38 @@ +--- +id: beta-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterAttributes', 'BetaManagedClusterAttributes'] +slug: /tools/sdk/python/beta/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'BetaManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**queue** | [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**keystore** | **str** | ManagedCluster keystore for spConnectCluster type | [optional] +} + +## Example + +```python +from sailpoint.beta.models.managed_cluster_attributes import ManagedClusterAttributes + +managed_cluster_attributes = ManagedClusterAttributes( +queue=sailpoint.beta.models.managed_cluster_queue.ManagedClusterQueue( + name = 'megapod-useast1-denali-lwt-cluster-1533', + region = 'us-east-1', ), +keystore='/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..20bbd3b67 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterKeyPair.md @@ -0,0 +1,38 @@ +--- +id: beta-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterKeyPair', 'BetaManagedClusterKeyPair'] +slug: /tools/sdk/python/beta/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'BetaManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +Managed Cluster key pair for Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**public_key** | **str** | ManagedCluster publicKey | [optional] +**public_key_thumbprint** | **str** | ManagedCluster publicKeyThumbprint | [optional] +**public_key_certificate** | **str** | ManagedCluster publicKeyCertificate | [optional] +} + +## Example + +```python +from sailpoint.beta.models.managed_cluster_key_pair import ManagedClusterKeyPair + +managed_cluster_key_pair = ManagedClusterKeyPair( +public_key='-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----', +public_key_thumbprint='6CMlaJIV44-xJxcB3CJBjDUUn54', +public_key_certificate='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterQueue.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..d8e0387af --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterQueue.md @@ -0,0 +1,36 @@ +--- +id: beta-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterQueue', 'BetaManagedClusterQueue'] +slug: /tools/sdk/python/beta/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'BetaManagedClusterQueue'] +--- + +# ManagedClusterQueue + +Managed Cluster key pair for Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | ManagedCluster queue name | [optional] +**region** | **str** | ManagedCluster queue aws region | [optional] +} + +## Example + +```python +from sailpoint.beta.models.managed_cluster_queue import ManagedClusterQueue + +managed_cluster_queue = ManagedClusterQueue( +name='megapod-useast1-denali-lwt-cluster-1533', +region='us-east-1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterRedis.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..7c8535c60 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterRedis.md @@ -0,0 +1,36 @@ +--- +id: beta-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterRedis', 'BetaManagedClusterRedis'] +slug: /tools/sdk/python/beta/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'BetaManagedClusterRedis'] +--- + +# ManagedClusterRedis + +Managed Cluster Redis Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**redis_host** | **str** | ManagedCluster redisHost | [optional] +**redis_port** | **int** | ManagedCluster redisPort | [optional] +} + +## Example + +```python +from sailpoint.beta.models.managed_cluster_redis import ManagedClusterRedis + +managed_cluster_redis = ManagedClusterRedis( +redis_host='megapod-useast1-shared-redis.cloud.sailpoint.com', +redis_port=6379 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterTypes.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..766ae5935 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagedClusterTypes.md @@ -0,0 +1,23 @@ +--- +id: beta-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterTypes', 'BetaManagedClusterTypes'] +slug: /tools/sdk/python/beta/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'BetaManagedClusterTypes'] +--- + +# ManagedClusterTypes + +The Type of Cluster + +## Enum + +* `IDN` (value: `'idn'`) + +* `IAI` (value: `'iai'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/python/Reference/Beta/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..5098fac3d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManagerCorrelationMapping.md @@ -0,0 +1,35 @@ +--- +id: beta-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagerCorrelationMapping', 'BetaManagerCorrelationMapping'] +slug: /tools/sdk/python/beta/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'BetaManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_attribute_name** | **str** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**identity_attribute_name** | **str** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.manager_correlation_mapping import ManagerCorrelationMapping + +manager_correlation_mapping = ManagerCorrelationMapping( +account_attribute_name='manager', +identity_attribute_name='manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManualDiscoverApplications.md b/docs/tools/sdk/python/Reference/Beta/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..5503e9843 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManualDiscoverApplications.md @@ -0,0 +1,35 @@ +--- +id: beta-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualDiscoverApplications', 'BetaManualDiscoverApplications'] +slug: /tools/sdk/python/beta/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'BetaManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] +} + +## Example + +```python +from sailpoint.beta.models.manual_discover_applications import ManualDiscoverApplications + +manual_discover_applications = ManualDiscoverApplications( +file='application_name,description +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App."' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/python/Reference/Beta/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..2e2df2945 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,35 @@ +--- +id: beta-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualDiscoverApplicationsTemplate', 'BetaManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/python/beta/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'BetaManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_name** | **str** | Name of the example application. | [optional] +**description** | **str** | Description of the example application. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate + +manual_discover_applications_template = ManualDiscoverApplicationsTemplate( +application_name='Example Application', +description='Example Description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..35acde18a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetails.md @@ -0,0 +1,57 @@ +--- +id: beta-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetails', 'BetaManualWorkItemDetails'] +slug: /tools/sdk/python/beta/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'BetaManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False] +**original_owner** | [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**current_owner** | [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**modified** | **datetime** | Time at which item was modified. | [optional] +**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.manual_work_item_details import ManualWorkItemDetails + +manual_work_item_details = ManualWorkItemDetails( +forwarded=True, +original_owner=sailpoint.beta.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +current_owner=sailpoint.beta.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +modified='2019-08-23T18:52:57.398Z', +status='PENDING', +forward_history=[ + sailpoint.beta.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..b930e2c64 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'BetaManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/python/beta/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'BetaManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +Identity of current work item owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of current work item owner's identity. | [optional] +**id** | **str** | ID of current work item owner's identity. | [optional] +**name** | **str** | Display name of current work item owner. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.manual_work_item_details_current_owner import ManualWorkItemDetailsCurrentOwner + +manual_work_item_details_current_owner = ManualWorkItemDetailsCurrentOwner( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..cb4464ca0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'BetaManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/python/beta/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'BetaManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +Identity of original work item owner, if the work item has been forwarded. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original work item owner's identity. | [optional] +**id** | **str** | ID of original work item owner's identity. | [optional] +**name** | **str** | Display name of original work item owner. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.manual_work_item_details_original_owner import ManualWorkItemDetailsOriginalOwner + +manual_work_item_details_original_owner = ManualWorkItemDetailsOriginalOwner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemState.md b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemState.md new file mode 100644 index 000000000..73fa2f703 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManualWorkItemState.md @@ -0,0 +1,31 @@ +--- +id: beta-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemState', 'BetaManualWorkItemState'] +slug: /tools/sdk/python/beta/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'BetaManualWorkItemState'] +--- + +# ManualWorkItemState + +Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. + +## Enum + +* `PENDING` (value: `'PENDING'`) + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `EXPIRED` (value: `'EXPIRED'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +* `ARCHIVED` (value: `'ARCHIVED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ManuallyUpdatedFieldsDTO.md b/docs/tools/sdk/python/Reference/Beta/Models/ManuallyUpdatedFieldsDTO.md new file mode 100644 index 000000000..7c5748eed --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ManuallyUpdatedFieldsDTO.md @@ -0,0 +1,35 @@ +--- +id: beta-manually-updated-fields-dto +title: ManuallyUpdatedFieldsDTO +pagination_label: ManuallyUpdatedFieldsDTO +sidebar_label: ManuallyUpdatedFieldsDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManuallyUpdatedFieldsDTO', 'BetaManuallyUpdatedFieldsDTO'] +slug: /tools/sdk/python/beta/models/manually-updated-fields-dto +tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO', 'BetaManuallyUpdatedFieldsDTO'] +--- + +# ManuallyUpdatedFieldsDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_name** | **bool** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to False] +**description** | **bool** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.manually_updated_fields_dto import ManuallyUpdatedFieldsDTO + +manually_updated_fields_dto = ManuallyUpdatedFieldsDTO( +display_name=True, +description=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MatchTerm.md b/docs/tools/sdk/python/Reference/Beta/Models/MatchTerm.md new file mode 100644 index 000000000..24c83900a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MatchTerm.md @@ -0,0 +1,43 @@ +--- +id: beta-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MatchTerm', 'BetaMatchTerm'] +slug: /tools/sdk/python/beta/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'BetaMatchTerm'] +--- + +# MatchTerm + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The attribute name | [optional] +**value** | **str** | The attribute value | [optional] +**op** | **str** | The operator between name and value | [optional] +**container** | **bool** | If it is a container or a real match term | [optional] [default to False] +**var_and** | **bool** | If it is AND logical operator for the children match terms | [optional] [default to False] +**children** | **[]Dict[str, object]** | The children under this match term | [optional] +} + +## Example + +```python +from sailpoint.beta.models.match_term import MatchTerm + +match_term = MatchTerm( +name='mail', +value='1234 Albany Dr', +op='eq', +container=True, +var_and=False, +children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Medium.md b/docs/tools/sdk/python/Reference/Beta/Models/Medium.md new file mode 100644 index 000000000..fd4cfdb08 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Medium.md @@ -0,0 +1,28 @@ +--- +id: beta-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Medium', 'BetaMedium'] +slug: /tools/sdk/python/beta/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'BetaMedium'] +--- + +# Medium + + +## Enum + +* `EMAIL` (value: `'EMAIL'`) + +* `SMS` (value: `'SMS'`) + +* `PHONE` (value: `'PHONE'`) + +* `SLACK` (value: `'SLACK'`) + +* `TEAMS` (value: `'TEAMS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MessageCatalogDto.md b/docs/tools/sdk/python/Reference/Beta/Models/MessageCatalogDto.md new file mode 100644 index 000000000..75dfc06c6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MessageCatalogDto.md @@ -0,0 +1,39 @@ +--- +id: beta-message-catalog-dto +title: MessageCatalogDto +pagination_label: MessageCatalogDto +sidebar_label: MessageCatalogDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MessageCatalogDto', 'BetaMessageCatalogDto'] +slug: /tools/sdk/python/beta/models/message-catalog-dto +tags: ['SDK', 'Software Development Kit', 'MessageCatalogDto', 'BetaMessageCatalogDto'] +--- + +# MessageCatalogDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | The language in which the messages are returned | [optional] +**messages** | [**[]ResourceBundleMessage**](resource-bundle-message) | The list of message with their keys and formats | [optional] +} + +## Example + +```python +from sailpoint.beta.models.message_catalog_dto import MessageCatalogDto + +message_catalog_dto = MessageCatalogDto( +locale='en_US', +messages=[ + sailpoint.beta.models.resource_bundle_message.ResourceBundleMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_LOW', + format = '{0,,\"i18n hint: percentage\"}% of identities with the same {1,,\"i18n hint: name of category feature\"} have this access. This information had a low impact on the overall score.', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MetricResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/MetricResponse.md new file mode 100644 index 000000000..1285650d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MetricResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MetricResponse', 'BetaMetricResponse'] +slug: /tools/sdk/python/beta/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'BetaMetricResponse'] +--- + +# MetricResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of metric | [optional] +**value** | **float** | the value associated to the metric | [optional] +} + +## Example + +```python +from sailpoint.beta.models.metric_response import MetricResponse + +metric_response = MetricResponse( +name='', +value=1.337 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MfaConfigTestResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..3ced0e77f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MfaConfigTestResponse.md @@ -0,0 +1,36 @@ +--- +id: beta-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaConfigTestResponse', 'BetaMfaConfigTestResponse'] +slug: /tools/sdk/python/beta/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'BetaMfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +Response model for configuration test of a given MFA method + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'FAILED' ] | The configuration test result. | [optional] [readonly] +**error** | **str** | The error message to indicate the failure of configuration test. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.mfa_config_test_response import MfaConfigTestResponse + +mfa_config_test_response = MfaConfigTestResponse( +state='SUCCESS', +error='MFA Method is disabled.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MfaDuoConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/MfaDuoConfig.md new file mode 100644 index 000000000..695506875 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MfaDuoConfig.md @@ -0,0 +1,43 @@ +--- +id: beta-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaDuoConfig', 'BetaMfaDuoConfig'] +slug: /tools/sdk/python/beta/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'BetaMfaDuoConfig'] +--- + +# MfaDuoConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfa_method** | **str** | Mfa method name | [optional] +**enabled** | **bool** | If MFA method is enabled. | [optional] [default to False] +**host** | **str** | The server host name or IP address of the MFA provider. | [optional] +**access_key** | **str** | The secret key for authenticating requests to the MFA provider. | [optional] +**identity_attribute** | **str** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**config_properties** | **map[string]object** | A map with additional config properties for the given MFA method - duo-web. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig + +mfa_duo_config = MfaDuoConfig( +mfa_method='duo-web', +enabled=True, +host='example.com', +access_key='qw123Y3QlA5UqocYpdU3rEkzrK2D497y', +identity_attribute='email', +config_properties={skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MfaOktaConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/MfaOktaConfig.md new file mode 100644 index 000000000..9f2cacd99 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MfaOktaConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaOktaConfig', 'BetaMfaOktaConfig'] +slug: /tools/sdk/python/beta/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'BetaMfaOktaConfig'] +--- + +# MfaOktaConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfa_method** | **str** | Mfa method name | [optional] +**enabled** | **bool** | If MFA method is enabled. | [optional] [default to False] +**host** | **str** | The server host name or IP address of the MFA provider. | [optional] +**access_key** | **str** | The secret key for authenticating requests to the MFA provider. | [optional] +**identity_attribute** | **str** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig + +mfa_okta_config = MfaOktaConfig( +mfa_method='okta-verify', +enabled=True, +host='example.com', +access_key='qw123Y3QlA5UqocYpdU3rEkzrK2D497y', +identity_attribute='email' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ModelField.md b/docs/tools/sdk/python/Reference/Beta/Models/ModelField.md new file mode 100644 index 000000000..6d975e338 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ModelField.md @@ -0,0 +1,43 @@ +--- +id: beta-model-field +title: ModelField +pagination_label: ModelField +sidebar_label: ModelField +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ModelField', 'BetaModelField'] +slug: /tools/sdk/python/beta/models/model-field +tags: ['SDK', 'Software Development Kit', 'ModelField', 'BetaModelField'] +--- + +# ModelField + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +**display_name** | **str** | Display name of the field | [optional] +**display_type** | **str** | Type of the field to display | [optional] +**required** | **bool** | True if the field is required | [optional] +**allowed_values_list** | **[]object** | List of allowed values for the field | [optional] +**value** | **object** | Value of the field | [optional] +} + +## Example + +```python +from sailpoint.beta.models.model_field import ModelField + +model_field = ModelField( +name='Field1', +display_name='Field 1', +display_type='checkbox', +required=True, +allowed_values_list=[{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}], +value=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md b/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md new file mode 100644 index 000000000..a429c4c93 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md @@ -0,0 +1,55 @@ +--- +id: beta-model-schema +title: ModelSchema +pagination_label: ModelSchema +sidebar_label: ModelSchema +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ModelSchema', 'BetaModelSchema'] +slug: /tools/sdk/python/beta/models/model-schema +tags: ['SDK', 'Software Development Kit', 'ModelSchema', 'BetaModelSchema'] +--- + +# ModelSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Schema. | [optional] +**name** | **str** | The name of the Schema. | [optional] +**native_object_type** | **str** | The name of the object type on the native system that the schema represents. | [optional] +**identity_attribute** | **str** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**display_attribute** | **str** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**hierarchy_attribute** | **str** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**configuration** | **object** | Holds any extra configuration data that the schema may require. | [optional] +**attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**created** | **datetime** | The date the Schema was created. | [optional] +**modified** | **datetime** | The date the Schema was last modified. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.model_schema import ModelSchema + +model_schema = ModelSchema( +id='2c9180835d191a86015d28455b4a2329', +name='account', +native_object_type='User', +identity_attribute='sAMAccountName', +display_attribute='distinguishedName', +hierarchy_attribute='memberOf', +include_permissions=False, +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +configuration={groupMemberAttribute=member}, +attributes=[{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}], +created='2019-12-24T22:32:58.104Z', +modified='2019-12-31T20:22:28.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationTemplateType.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationTemplateType.md new file mode 100644 index 000000000..16e51ea3f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationTemplateType.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-integration-template-type +title: MultiHostIntegrationTemplateType +pagination_label: MultiHostIntegrationTemplateType +sidebar_label: MultiHostIntegrationTemplateType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationTemplateType', 'BetaMultiHostIntegrationTemplateType'] +slug: /tools/sdk/python/beta/models/multi-host-integration-template-type +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'BetaMultiHostIntegrationTemplateType'] +--- + +# MultiHostIntegrationTemplateType + +This represents a Multi-Host Integration template type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This is the name of the type. | [optional] +**type** | **str** | This is the type value for the type. | [required] +**script_name** | **str** | This is the scriptName attribute value for the type. | [required] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType + +multi_host_integration_template_type = MultiHostIntegrationTemplateType( +name='aName', +type='aType', +script_name='aScriptName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrations.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrations.md new file mode 100644 index 000000000..464d900cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrations.md @@ -0,0 +1,90 @@ +--- +id: beta-multi-host-integrations +title: MultiHostIntegrations +pagination_label: MultiHostIntegrations +sidebar_label: MultiHostIntegrations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrations', 'BetaMultiHostIntegrations'] +slug: /tools/sdk/python/beta/models/multi-host-integrations +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'BetaMultiHostIntegrations'] +--- + +# MultiHostIntegrations + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Multi-Host Integration ID. | [required][readonly] +**name** | **str** | Multi-Host Integration's human-readable name. | [required] +**description** | **str** | Multi-Host Integration's human-readable description. | [required] +**owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**cluster** | [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**type** | **str** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**connector** | **str** | Connector script name. | [required] +**last_source_upload_success_count** | **int** | Last successfully uploaded source count of given Multi-Host Integration. | [optional] +**max_sources_per_agg_group** | **int** | Maximum sources that can contain in a aggregation group of Multi-Host Integration. | [optional] +**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**connector_attributes** | [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional] +**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False] +**management_workgroup** | [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**since** | **datetime** | Timestamp that shows when a source health check was last performed. | [optional] +**connector_id** | **str** | Connector ID | [optional] +**connector_name** | **str** | Name of the connector that was chosen during source creation. | [optional] +**connection_type** | **Enum** [ 'direct', 'file' ] | Type of connection (direct or file). | [optional] +**connector_implementation_id** | **str** | Connector implementation ID. | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False] +**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations + +multi_host_integrations = MultiHostIntegrations( +id='2c91808568c529c60168cca6f90c1324', +name='My Multi-Host Integration', +description='This is a Multi-Host Integration.', +owner=sailpoint.beta.models.multi_host_integrations_owner.MultiHostIntegrations_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'MyName', ), +cluster=sailpoint.beta.models.multi_host_integrations_cluster.MultiHostIntegrations_cluster( + type = 'CLUSTER', + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Corporate Cluster', ), +type='Multi-Host - Microsoft SQL Server', +connector='multihost-microsoft-sql-server', +last_source_upload_success_count=50, +max_sources_per_agg_group=10, +connector_class='sailpoint.connector.OpenConnectorAdapter', +connector_attributes={multiHostAttributes={password=Password, user=Username, connector_files=mssql-jdbc-8.4.1.jre8.jar, authType=SQLAuthentication}, connectorFileUploadHistory={connectorFileNameUploadedDate=2024-08-29T10:20:38.896479Z}, maxAllowedSources=30, lastSourceUploadCount=50, showEntitlementSchema=true, showAccountSchema=true, multihost_status=ready}, +delete_threshold=10, +authoritative=False, +management_workgroup=sailpoint.beta.models.multi_host_integrations_management_workgroup.MultiHostIntegrations_managementWorkgroup( + type = 'GOVERNANCE_GROUP', + id = '2c91808568c529c60168cca6f90c2222', + name = 'My Management Workgroup', ), +healthy=True, +status='SOURCE_STATE_HEALTHY', +since=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +connector_id='multihost-microsoft-sql-server', +connector_name='Multi-Host Microsoft SQL Server', +connection_type='direct', +connector_implementation_id='multihost-microsoft-sql-server', +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z', +credential_provider_enabled=False, +category='CredentialProvider' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsAggScheduleUpdate.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsAggScheduleUpdate.md new file mode 100644 index 000000000..0d6ca5d98 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsAggScheduleUpdate.md @@ -0,0 +1,47 @@ +--- +id: beta-multi-host-integrations-agg-schedule-update +title: MultiHostIntegrationsAggScheduleUpdate +pagination_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'BetaMultiHostIntegrationsAggScheduleUpdate'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-agg-schedule-update +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'BetaMultiHostIntegrationsAggScheduleUpdate'] +--- + +# MultiHostIntegrationsAggScheduleUpdate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**multihost_id** | **str** | Multi-Host Integration ID. The ID must be unique | [required] +**aggregation_grp_id** | **str** | Multi-Host Integration aggregation group ID | [required] +**aggregation_grp_name** | **str** | Multi-Host Integration name | [required] +**aggregation_cron_schedule** | **str** | Cron expression to schedule aggregation | [required] +**enable_schedule** | **bool** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [required][default to False] +**source_id_list** | **[]str** | Source IDs of the Multi-Host Integration | [required] +**created** | **datetime** | Created date of Multi-Host Integration aggregation schedule | [optional] +**modified** | **datetime** | Modified date of Multi-Host Integration aggregation schedule | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate + +multi_host_integrations_agg_schedule_update = MultiHostIntegrationsAggScheduleUpdate( +multihost_id='004091cb79b04636b88662afa50a4456', +aggregation_grp_id='004091cb79b04636b88662afa50a4448', +aggregation_grp_name='Multi-Host Integration aggregation group name', +aggregation_cron_schedule='0 0 0 * * ?', +enable_schedule=False, +source_id_list=[004091cb79b04636b88662afa50a4440, 00af6d0d562a49b591c47be908740542], +created='2024-01-23T18:08:50.897Z', +modified='2024-01-23T18:08:50.897Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCluster.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCluster.md new file mode 100644 index 000000000..dc3e3f459 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCluster.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-integrations-cluster +title: MultiHostIntegrationsCluster +pagination_label: MultiHostIntegrationsCluster +sidebar_label: MultiHostIntegrationsCluster +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCluster', 'BetaMultiHostIntegrationsCluster'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-cluster +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCluster', 'BetaMultiHostIntegrationsCluster'] +--- + +# MultiHostIntegrationsCluster + +Reference to the source's associated cluster. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CLUSTER' ] | Type of object being referenced. | [required] +**id** | **str** | Cluster ID. | [required] +**name** | **str** | Cluster's human-readable display name. | [required] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_cluster import MultiHostIntegrationsCluster + +multi_host_integrations_cluster = MultiHostIntegrationsCluster( +type='CLUSTER', +id='2c9180866166b5b0016167c32ef31a66', +name='Corporate Cluster' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributes.md new file mode 100644 index 000000000..826ec574d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributes.md @@ -0,0 +1,51 @@ +--- +id: beta-multi-host-integrations-connector-attributes +title: MultiHostIntegrationsConnectorAttributes +pagination_label: MultiHostIntegrationsConnectorAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'BetaMultiHostIntegrationsConnectorAttributes'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-connector-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'BetaMultiHostIntegrationsConnectorAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributes + +Connector specific configuration. This configuration will differ for Multi-Host Integration type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_allowed_sources** | **int** | Maximum sources allowed count of a Multi-Host Integration | [optional] +**last_source_upload_count** | **int** | Last upload sources count of a Multi-Host Integration | [optional] +**connector_file_upload_history** | [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional] +**multihost_status** | **Enum** [ 'ready', 'processing', 'fileUploadInProgress', 'sourceCreationInProgress', 'aggregationGroupingInProgress', 'aggregationScheduleInProgress', 'deleteInProgress', 'deleteFailed' ] | Multi-Host integration status. | [optional] +**show_account_schema** | **bool** | Show account schema | [optional] [default to True] +**show_entitlement_schema** | **bool** | Show entitlement schema | [optional] [default to True] +**multi_host_attributes** | [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_connector_attributes import MultiHostIntegrationsConnectorAttributes + +multi_host_integrations_connector_attributes = MultiHostIntegrationsConnectorAttributes( +max_allowed_sources=250, +last_source_upload_count=40, +connector_file_upload_history=sailpoint.beta.models.multi_host_integrations_connector_attributes_connector_file_upload_history.MultiHostIntegrations_connectorAttributes_connectorFileUploadHistory( + connector_file_name_uploaded_date = '2024-08-29T10:20:38.896479Z', ), +multihost_status='ready', +show_account_schema=True, +show_entitlement_schema=True, +multi_host_attributes=sailpoint.beta.models.multi_host_integrations_connector_attributes_multi_host_attributes.MultiHostIntegrations_connectorAttributes_multiHostAttributes( + password = 'Password', + connector_files = 'mssql-jdbc-8.4.1.jre8.jar', + auth_type = 'SQLAuthentication', + user = 'My Username', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md new file mode 100644 index 000000000..218708806 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md @@ -0,0 +1,33 @@ +--- +id: beta-multi-host-integrations-connector-attributes-connector-file-upload-history +title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-connector-attributes-connector-file-upload-history +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +--- + +# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connector_file_name_uploaded_date** | **str** | File name of the connector JAR | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_connector_attributes_connector_file_upload_history import MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +multi_host_integrations_connector_attributes_connector_file_upload_history = MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory( +connector_file_name_uploaded_date='2024-08-29T10:20:38.896479Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md new file mode 100644 index 000000000..088f081ab --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md @@ -0,0 +1,40 @@ +--- +id: beta-multi-host-integrations-connector-attributes-multi-host-attributes +title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-connector-attributes-multi-host-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributesMultiHostAttributes + +Attributes of Multi-Host Integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | Password. | [optional] +**connector_files** | **str** | Connector file. | [optional] +**auth_type** | **str** | Authentication type. | [optional] +**user** | **str** | Username. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_connector_attributes_multi_host_attributes import MultiHostIntegrationsConnectorAttributesMultiHostAttributes + +multi_host_integrations_connector_attributes_multi_host_attributes = MultiHostIntegrationsConnectorAttributesMultiHostAttributes( +password='Password', +connector_files='mssql-jdbc-8.4.1.jre8.jar', +auth_type='SQLAuthentication', +user='My Username' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCreate.md new file mode 100644 index 000000000..cbeff6baa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCreate.md @@ -0,0 +1,58 @@ +--- +id: beta-multi-host-integrations-create +title: MultiHostIntegrationsCreate +pagination_label: MultiHostIntegrationsCreate +sidebar_label: MultiHostIntegrationsCreate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCreate', 'BetaMultiHostIntegrationsCreate'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-create +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'BetaMultiHostIntegrationsCreate'] +--- + +# MultiHostIntegrationsCreate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Multi-Host Integration's human-readable name. | [required] +**description** | **str** | Multi-Host Integration's human-readable description. | [required] +**owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**cluster** | [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**connector** | **str** | Connector script name. | [required] +**connector_attributes** | **map[string]object** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional] +**management_workgroup** | [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_create import MultiHostIntegrationsCreate + +multi_host_integrations_create = MultiHostIntegrationsCreate( +name='My Multi-Host Integration', +description='This is the Multi-Host Integration.', +owner=sailpoint.beta.models.multi_host_integrations_owner.MultiHostIntegrations_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'MyName', ), +cluster=sailpoint.beta.models.multi_host_integrations_cluster.MultiHostIntegrations_cluster( + type = 'CLUSTER', + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Corporate Cluster', ), +connector='multihost-microsoft-sql-server', +connector_attributes={maxSourcesPerAggGroup=10, maxAllowedSources=300}, +management_workgroup=sailpoint.beta.models.multi_host_integrations_management_workgroup.MultiHostIntegrations_managementWorkgroup( + type = 'GOVERNANCE_GROUP', + id = '2c91808568c529c60168cca6f90c2222', + name = 'My Management Workgroup', ), +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md new file mode 100644 index 000000000..adf3957a1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-integrations-create-sources +title: MultiHostIntegrationsCreateSources +pagination_label: MultiHostIntegrationsCreateSources +sidebar_label: MultiHostIntegrationsCreateSources +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCreateSources', 'BetaMultiHostIntegrationsCreateSources'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-create-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'BetaMultiHostIntegrationsCreateSources'] +--- + +# MultiHostIntegrationsCreateSources + +This represents sources to be created of same type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Source's human-readable name. | [required] +**description** | **str** | Source's human-readable description. | [optional] +**connector_attributes** | **map[string]object** | Connector specific configuration. This configuration will differ from type to type. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources + +multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources( +name='My Source', +description='This is the corporate directory.', +connector_attributes={authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsManagementWorkgroup.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsManagementWorkgroup.md new file mode 100644 index 000000000..fd245c3fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsManagementWorkgroup.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-integrations-management-workgroup +title: MultiHostIntegrationsManagementWorkgroup +pagination_label: MultiHostIntegrationsManagementWorkgroup +sidebar_label: MultiHostIntegrationsManagementWorkgroup +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsManagementWorkgroup', 'BetaMultiHostIntegrationsManagementWorkgroup'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-management-workgroup +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsManagementWorkgroup', 'BetaMultiHostIntegrationsManagementWorkgroup'] +--- + +# MultiHostIntegrationsManagementWorkgroup + +Reference to management workgroup for the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP' ] | Type of object being referenced. | [optional] +**id** | **str** | Management workgroup ID. | [optional] +**name** | **str** | Management workgroup's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_management_workgroup import MultiHostIntegrationsManagementWorkgroup + +multi_host_integrations_management_workgroup = MultiHostIntegrationsManagementWorkgroup( +type='GOVERNANCE_GROUP', +id='2c91808568c529c60168cca6f90c2222', +name='My Management Workgroup' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsOwner.md new file mode 100644 index 000000000..67f8ca080 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostIntegrationsOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-integrations-owner +title: MultiHostIntegrationsOwner +pagination_label: MultiHostIntegrationsOwner +sidebar_label: MultiHostIntegrationsOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsOwner', 'BetaMultiHostIntegrationsOwner'] +slug: /tools/sdk/python/beta/models/multi-host-integrations-owner +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsOwner', 'BetaMultiHostIntegrationsOwner'] +--- + +# MultiHostIntegrationsOwner + +Reference to identity object who owns the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Type of object being referenced. | [optional] +**id** | **str** | Owner identity's ID. | [optional] +**name** | **str** | Owner identity's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_integrations_owner import MultiHostIntegrationsOwner + +multi_host_integrations_owner = MultiHostIntegrationsOwner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='MyName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSources.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSources.md new file mode 100644 index 000000000..400085203 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSources.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources +title: MultiHostSources +pagination_label: MultiHostSources +sidebar_label: MultiHostSources +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSources', 'BetaMultiHostSources'] +slug: /tools/sdk/python/beta/models/multi-host-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'BetaMultiHostSources'] +--- + +# MultiHostSources + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Source ID. | [required][readonly] +**name** | **str** | Source's human-readable name. | [required] +**description** | **str** | Source's human-readable description. | [optional] +**owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**cluster** | [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**account_correlation_config** | [**MultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] +**account_correlation_rule** | [**MultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] +**manager_correlation_mapping** | [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**manager_correlation_rule** | [**MultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] +**before_provisioning_rule** | [**MultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] +**schemas** | [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] +**password_policies** | [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**type** | **str** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**connector** | **str** | Connector script name. | [required] +**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**connector_attributes** | **map[string]object** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False] +**management_workgroup** | [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**since** | **datetime** | Timestamp that shows when a source health check was last performed. | [optional] +**connector_id** | **str** | Connector ID | [optional] +**connector_name** | **str** | Name of the connector that was chosen during source creation. | [required] +**connection_type** | **str** | Type of connection (direct or file). | [optional] +**connector_implementation_id** | **str** | Connector implementation ID. | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False] +**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources import MultiHostSources + +multi_host_sources = MultiHostSources( +id='2c91808568c529c60168cca6f90c1324', +name='My Source', +description='This is the Source.', +owner=sailpoint.beta.models.multi_host_integrations_owner.MultiHostIntegrations_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'MyName', ), +cluster=sailpoint.beta.models.multi_host_integrations_cluster.MultiHostIntegrations_cluster( + type = 'CLUSTER', + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Corporate Cluster', ), +account_correlation_config=sailpoint.beta.models.multi_host_sources_account_correlation_config.MultiHostSources_accountCorrelationConfig( + type = 'ACCOUNT_CORRELATION_CONFIG', + id = '2c9180855d191c59015d28583727245a', + name = 'Directory [source-62867] Account Correlation', ), +account_correlation_rule=sailpoint.beta.models.multi_host_sources_account_correlation_rule.MultiHostSources_accountCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +manager_correlation_mapping=sailpoint.beta.models.manager_correlation_mapping.ManagerCorrelationMapping( + account_attribute_name = 'manager', + identity_attribute_name = 'manager', ), +manager_correlation_rule=sailpoint.beta.models.multi_host_sources_manager_correlation_rule.MultiHostSources_managerCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +before_provisioning_rule=sailpoint.beta.models.multi_host_sources_before_provisioning_rule.MultiHostSources_beforeProvisioningRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}], +password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}], +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +type='Multi-Host - Microsoft SQL Server', +connector='multihost-microsoft-sql-server', +connector_class='sailpoint.connector.OpenConnectorAdapter', +connector_attributes={healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]}, +delete_threshold=10, +authoritative=False, +management_workgroup=sailpoint.beta.models.multi_host_integrations_management_workgroup.MultiHostIntegrations_managementWorkgroup( + type = 'GOVERNANCE_GROUP', + id = '2c91808568c529c60168cca6f90c2222', + name = 'My Management Workgroup', ), +healthy=True, +status='SOURCE_STATE_HEALTHY', +since=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +connector_id='multihost-microsoft-sql-server', +connector_name='Multi-Host Microsoft SQL Server', +connection_type='file', +connector_implementation_id='multihost-microsoft-sql-server', +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z', +credential_provider_enabled=False, +category='CredentialProvider' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesAccountCorrelationConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesAccountCorrelationConfig.md new file mode 100644 index 000000000..0784a5857 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesAccountCorrelationConfig.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-sources-account-correlation-config +title: MultiHostSourcesAccountCorrelationConfig +pagination_label: MultiHostSourcesAccountCorrelationConfig +sidebar_label: MultiHostSourcesAccountCorrelationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSourcesAccountCorrelationConfig', 'BetaMultiHostSourcesAccountCorrelationConfig'] +slug: /tools/sdk/python/beta/models/multi-host-sources-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationConfig', 'BetaMultiHostSourcesAccountCorrelationConfig'] +--- + +# MultiHostSourcesAccountCorrelationConfig + +Reference to account correlation config object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT_CORRELATION_CONFIG' ] | Type of object being referenced. | [optional] +**id** | **str** | Account correlation config ID. | [optional] +**name** | **str** | Account correlation config's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources_account_correlation_config import MultiHostSourcesAccountCorrelationConfig + +multi_host_sources_account_correlation_config = MultiHostSourcesAccountCorrelationConfig( +type='ACCOUNT_CORRELATION_CONFIG', +id='2c9180855d191c59015d28583727245a', +name='Directory [source-62867] Account Correlation' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesAccountCorrelationRule.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesAccountCorrelationRule.md new file mode 100644 index 000000000..484abb093 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesAccountCorrelationRule.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-sources-account-correlation-rule +title: MultiHostSourcesAccountCorrelationRule +pagination_label: MultiHostSourcesAccountCorrelationRule +sidebar_label: MultiHostSourcesAccountCorrelationRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSourcesAccountCorrelationRule', 'BetaMultiHostSourcesAccountCorrelationRule'] +slug: /tools/sdk/python/beta/models/multi-host-sources-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationRule', 'BetaMultiHostSourcesAccountCorrelationRule'] +--- + +# MultiHostSourcesAccountCorrelationRule + +Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources_account_correlation_rule import MultiHostSourcesAccountCorrelationRule + +multi_host_sources_account_correlation_rule = MultiHostSourcesAccountCorrelationRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesBeforeProvisioningRule.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesBeforeProvisioningRule.md new file mode 100644 index 000000000..71cb40cc8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesBeforeProvisioningRule.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-sources-before-provisioning-rule +title: MultiHostSourcesBeforeProvisioningRule +pagination_label: MultiHostSourcesBeforeProvisioningRule +sidebar_label: MultiHostSourcesBeforeProvisioningRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSourcesBeforeProvisioningRule', 'BetaMultiHostSourcesBeforeProvisioningRule'] +slug: /tools/sdk/python/beta/models/multi-host-sources-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesBeforeProvisioningRule', 'BetaMultiHostSourcesBeforeProvisioningRule'] +--- + +# MultiHostSourcesBeforeProvisioningRule + +Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources_before_provisioning_rule import MultiHostSourcesBeforeProvisioningRule + +multi_host_sources_before_provisioning_rule = MultiHostSourcesBeforeProvisioningRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesManagerCorrelationRule.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesManagerCorrelationRule.md new file mode 100644 index 000000000..a4eec56bb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesManagerCorrelationRule.md @@ -0,0 +1,38 @@ +--- +id: beta-multi-host-sources-manager-correlation-rule +title: MultiHostSourcesManagerCorrelationRule +pagination_label: MultiHostSourcesManagerCorrelationRule +sidebar_label: MultiHostSourcesManagerCorrelationRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSourcesManagerCorrelationRule', 'BetaMultiHostSourcesManagerCorrelationRule'] +slug: /tools/sdk/python/beta/models/multi-host-sources-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesManagerCorrelationRule', 'BetaMultiHostSourcesManagerCorrelationRule'] +--- + +# MultiHostSourcesManagerCorrelationRule + +Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources_manager_correlation_rule import MultiHostSourcesManagerCorrelationRule + +multi_host_sources_manager_correlation_rule = MultiHostSourcesManagerCorrelationRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesPasswordPoliciesInner.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesPasswordPoliciesInner.md new file mode 100644 index 000000000..85c078404 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesPasswordPoliciesInner.md @@ -0,0 +1,37 @@ +--- +id: beta-multi-host-sources-password-policies-inner +title: MultiHostSourcesPasswordPoliciesInner +pagination_label: MultiHostSourcesPasswordPoliciesInner +sidebar_label: MultiHostSourcesPasswordPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSourcesPasswordPoliciesInner', 'BetaMultiHostSourcesPasswordPoliciesInner'] +slug: /tools/sdk/python/beta/models/multi-host-sources-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesPasswordPoliciesInner', 'BetaMultiHostSourcesPasswordPoliciesInner'] +--- + +# MultiHostSourcesPasswordPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'PASSWORD_POLICY' ] | Type of object being referenced. | [optional] +**id** | **str** | Policy ID. | [optional] +**name** | **str** | Policy's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources_password_policies_inner import MultiHostSourcesPasswordPoliciesInner + +multi_host_sources_password_policies_inner = MultiHostSourcesPasswordPoliciesInner( +type='PASSWORD_POLICY', +id='2c91808568c529c60168cca6f90c1777', +name='My Password Policy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesSchemasInner.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesSchemasInner.md new file mode 100644 index 000000000..14d156d82 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiHostSourcesSchemasInner.md @@ -0,0 +1,37 @@ +--- +id: beta-multi-host-sources-schemas-inner +title: MultiHostSourcesSchemasInner +pagination_label: MultiHostSourcesSchemasInner +sidebar_label: MultiHostSourcesSchemasInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiHostSourcesSchemasInner', 'BetaMultiHostSourcesSchemasInner'] +slug: /tools/sdk/python/beta/models/multi-host-sources-schemas-inner +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesSchemasInner', 'BetaMultiHostSourcesSchemasInner'] +--- + +# MultiHostSourcesSchemasInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | Type of object being referenced. | [optional] +**id** | **str** | Schema ID. | [optional] +**name** | **str** | Schema's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_host_sources_schemas_inner import MultiHostSourcesSchemasInner + +multi_host_sources_schemas_inner = MultiHostSourcesSchemasInner( +type='CONNECTOR_SCHEMA', +id='2c91808568c529c60168cca6f90c1777', +name='MySchema' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/MultiPolicyRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..e0f952905 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/MultiPolicyRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiPolicyRequest', 'BetaMultiPolicyRequest'] +slug: /tools/sdk/python/beta/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'BetaMultiPolicyRequest'] +--- + +# MultiPolicyRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filtered_policy_list** | **[]str** | Multi-policy report will be run for this list of ids | [optional] +} + +## Example + +```python +from sailpoint.beta.models.multi_policy_request import MultiPolicyRequest + +multi_policy_request = MultiPolicyRequest( +filtered_policy_list=[ + '' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..f734ea13d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,44 @@ +--- +id: beta-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NativeChangeDetectionConfig', 'BetaNativeChangeDetectionConfig'] +slug: /tools/sdk/python/beta/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'BetaNativeChangeDetectionConfig'] +--- + +# NativeChangeDetectionConfig + +Source configuration information for Native Change Detection that is read and used by account aggregation process. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to False] +**operations** | **[]str** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**all_entitlements** | **bool** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to False] +**all_non_entitlement_attributes** | **bool** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to False] +**selected_entitlements** | **[]str** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**selected_non_entitlement_attributes** | **[]str** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.native_change_detection_config import NativeChangeDetectionConfig + +native_change_detection_config = NativeChangeDetectionConfig( +enabled=True, +operations=[ACCOUNT_UPDATED, ACCOUNT_DELETED], +all_entitlements=False, +all_non_entitlement_attributes=False, +selected_entitlements=[memberOf, memberOfSharedMailbox], +selected_non_entitlement_attributes=[lastName, phoneNumber, objectType, servicePrincipalName] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..49450f1b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,33 @@ +--- +id: beta-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalDecision', 'BetaNonEmployeeApprovalDecision'] +slug: /tools/sdk/python/beta/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'BetaNonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment on the approval item. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_approval_decision import NonEmployeeApprovalDecision + +non_employee_approval_decision = NonEmployeeApprovalDecision( +comment='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..39ddbd2cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,55 @@ +--- +id: beta-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItem', 'BetaNonEmployeeApprovalItem'] +slug: /tools/sdk/python/beta/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'BetaNonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_request** | [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem + +non_employee_approval_item = NonEmployeeApprovalItem( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='true', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_request=sailpoint.beta.models.non_employee_request_lite.NonEmployeeRequestLite( + id = 'ac10e21c-931c-1ef2-8193-1c51e7ff0003', + requester = sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..3b107574b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,49 @@ +--- +id: beta-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItemBase', 'BetaNonEmployeeApprovalItemBase'] +slug: /tools/sdk/python/beta/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'BetaNonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_approval_item_base import NonEmployeeApprovalItemBase + +non_employee_approval_item_base = NonEmployeeApprovalItemBase( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='true', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..de721b6c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItemDetail', 'BetaNonEmployeeApprovalItemDetail'] +slug: /tools/sdk/python/beta/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'BetaNonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_request** | [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail + +non_employee_approval_item_detail = NonEmployeeApprovalItemDetail( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='true', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_request= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..f13827375 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,37 @@ +--- +id: beta-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalSummary', 'BetaNonEmployeeApprovalSummary'] +slug: /tools/sdk/python/beta/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'BetaNonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **float** | The number of approved non-employee approval requests. | [optional] +**pending** | **float** | The number of pending non-employee approval requests. | [optional] +**rejected** | **float** | The number of rejected non-employee approval requests. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_approval_summary import NonEmployeeApprovalSummary + +non_employee_approval_summary = NonEmployeeApprovalSummary( +approved=1.337, +pending=1.337, +rejected=1.337 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..c6fd8b129 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,41 @@ +--- +id: beta-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeBulkUploadJob', 'BetaNonEmployeeBulkUploadJob'] +slug: /tools/sdk/python/beta/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'BetaNonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The bulk upload job's ID. (UUID) | [optional] +**source_id** | **str** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**created** | **datetime** | The date-time the job was submitted. | [optional] +**modified** | **datetime** | The date-time that the job was last updated. | [optional] +**status** | **Enum** [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'ERROR' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob + +non_employee_bulk_upload_job = NonEmployeeBulkUploadJob( +id='2c91808568c529c60168cca6f90cffff', +source_id='2c91808568c529c60168cca6f90c1313', +created='2019-08-23T18:52:59.162Z', +modified='2019-08-23T18:52:59.162Z', +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..39ac06e94 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,33 @@ +--- +id: beta-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeBulkUploadStatus', 'BetaNonEmployeeBulkUploadStatus'] +slug: /tools/sdk/python/beta/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'BetaNonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'ERROR' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus + +non_employee_bulk_upload_status = NonEmployeeBulkUploadStatus( +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..4b83a55b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdnUserRequest', 'BetaNonEmployeeIdnUserRequest'] +slug: /tools/sdk/python/beta/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'BetaNonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity id. | [required] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_idn_user_request import NonEmployeeIdnUserRequest + +non_employee_idn_user_request = NonEmployeeIdnUserRequest( +id='2c91808570313110017040b06f344ec9' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRecord.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..3298d8915 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRecord.md @@ -0,0 +1,57 @@ +--- +id: beta-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRecord', 'BetaNonEmployeeRecord'] +slug: /tools/sdk/python/beta/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'BetaNonEmployeeRecord'] +--- + +# NonEmployeeRecord + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee record id. | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**source_id** | **str** | Non-Employee's source id. | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [optional] +**end_date** | **datetime** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_record import NonEmployeeRecord + +non_employee_record = NonEmployeeRecord( +id='ac10e21c-931c-1ef2-8193-1c51e7ff0003', +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +source_id='2c91808568c529c60168cca6f90c1313', +data={description=Auditing}, +start_date='2019-08-23T18:52:59.162Z', +end_date='2020-08-23T18:52:59.162Z', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..b3e4a596a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,33 @@ +--- +id: beta-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRejectApprovalDecision', 'BetaNonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/python/beta/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'BetaNonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment on the approval item. | [required] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision + +non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision( +comment='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..20996ff73 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequest.md @@ -0,0 +1,87 @@ +--- +id: beta-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequest', 'BetaNonEmployeeRequest'] +slug: /tools/sdk/python/beta/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'BetaNonEmployeeRequest'] +--- + +# NonEmployeeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**non_employee_source** | [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**approval_items** | [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**comment** | **str** | Comment of requester | [optional] +**completion_date** | **datetime** | When the request was completely approved. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [optional] +**end_date** | **datetime** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_request import NonEmployeeRequest + +non_employee_request = NonEmployeeRequest( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +non_employee_source=sailpoint.beta.models.non_employee_source_lite.NonEmployeeSourceLite( + id = 'a0303682-5e4a-44f7-bdc2-6ce6112549c1', + source_id = '2c91808568c529c60168cca6f90c1313', + name = 'Retail', + description = 'Source description', ), +data={description=Auditing}, +approval_items=[ + sailpoint.beta.models.non_employee_approval_item_base.NonEmployeeApprovalItemBase( + id = '2c1e388b-1e55-4b0a-ab5c-897f1204159c', + approver = sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), + account_name = 'test.account', + approval_status = 'APPROVED', + approval_order = 1, + comment = 'true', + modified = '2019-08-23T18:52:59.162Z', + created = '2019-08-23T18:40:35.772Z', ) + ], +approval_status='APPROVED', +comment='approved', +completion_date='2020-03-24T11:11:41.139-05:00', +start_date='2020-03-24T00:00-05:00', +end_date='2021-03-25T00:00-05:00', +modified='2020-03-24T11:11:41.139-05:00', +created='2020-03-24T11:11:41.139-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..262f15dcf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestBody.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestBody', 'BetaNonEmployeeRequestBody'] +slug: /tools/sdk/python/beta/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'BetaNonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_name** | **str** | Requested identity account name. | [required] +**first_name** | **str** | Non-Employee's first name. | [required] +**last_name** | **str** | Non-Employee's last name. | [required] +**email** | **str** | Non-Employee's email. | [required] +**phone** | **str** | Non-Employee's phone. | [required] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [required] +**source_id** | **str** | Non-Employee's source id. | [required] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [required] +**end_date** | **datetime** | Non-Employee employment end date. | [required] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody + +non_employee_request_body = NonEmployeeRequestBody( +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +source_id='2c91808568c529c60168cca6f90c1313', +data={description=Auditing}, +start_date='2020-03-24T00:00-05:00', +end_date='2021-03-25T00:00-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..e40f4d768 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestLite.md @@ -0,0 +1,37 @@ +--- +id: beta-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestLite', 'BetaNonEmployeeRequestLite'] +slug: /tools/sdk/python/beta/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'BetaNonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee request id. | [optional] +**requester** | [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_request_lite import NonEmployeeRequestLite + +non_employee_request_lite = NonEmployeeRequestLite( +id='ac10e21c-931c-1ef2-8193-1c51e7ff0003', +requester=sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..914f1023b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,39 @@ +--- +id: beta-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestSummary', 'BetaNonEmployeeRequestSummary'] +slug: /tools/sdk/python/beta/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'BetaNonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **float** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**rejected** | **float** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**pending** | **float** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**non_employee_count** | **float** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_request_summary import NonEmployeeRequestSummary + +non_employee_request_summary = NonEmployeeRequestSummary( +approved=1.337, +rejected=1.337, +pending=1.337, +non_employee_count=1.337 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..e0b91fdea --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,67 @@ +--- +id: beta-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'BetaNonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/python/beta/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'BetaNonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee request id. | [optional] +**requester** | [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**non_employee_source** | [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**comment** | **str** | Comment of requester | [optional] +**completion_date** | **datetime** | When the request was completely approved. | [optional] +**start_date** | **date** | Non-Employee employment start date. | [optional] +**end_date** | **date** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_request_without_approval_item import NonEmployeeRequestWithoutApprovalItem + +non_employee_request_without_approval_item = NonEmployeeRequestWithoutApprovalItem( +id='ac10e21c-931c-1ef2-8193-1c51e7ff0003', +requester=sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +non_employee_source=, +data={description=Auditing}, +approval_status='APPROVED', +comment='approved', +completion_date='2020-03-24T11:11:41.139-05:00', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', +modified='2020-03-24T11:11:41.139-05:00', +created='2020-03-24T11:11:41.139-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..39a668307 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttribute', 'BetaNonEmployeeSchemaAttribute'] +slug: /tools/sdk/python/beta/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'BetaNonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Schema Attribute Id | [optional] +**system** | **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to False] +**modified** | **datetime** | When the schema attribute was last modified. | [optional] +**created** | **datetime** | When the schema attribute was created. | [optional] +**type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] +**label** | **str** | Label displayed on the UI for this schema attribute. | [required] +**technical_name** | **str** | The technical name of the attribute. Must be unique per source. | [required] +**help_text** | **str** | help text displayed by UI. | [optional] +**placeholder** | **str** | Hint text that fills UI box. | [optional] +**required** | **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + +non_employee_schema_attribute = NonEmployeeSchemaAttribute( +id='ac110005-7156-1150-8171-5b292e3e0084', +system=True, +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +type='TEXT', +label='Account Name', +technical_name='account.name', +help_text='The unique identifier for the account', +placeholder='Enter a unique user name for this account.', +required=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..0fcb0aa65 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,43 @@ +--- +id: beta-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttributeBody', 'BetaNonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/python/beta/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'BetaNonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] +**label** | **str** | Label displayed on the UI for this schema attribute. | [required] +**technical_name** | **str** | The technical name of the attribute. Must be unique per source. | [required] +**help_text** | **str** | help text displayed by UI. | [optional] +**placeholder** | **str** | Hint text that fills UI box. | [optional] +**required** | **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody + +non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody( +type='TEXT', +label='Account Name', +technical_name='account.name', +help_text='The unique identifier for the account', +placeholder='Enter a unique user name for this account.', +required=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..a935897a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,25 @@ +--- +id: beta-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttributeType', 'BetaNonEmployeeSchemaAttributeType'] +slug: /tools/sdk/python/beta/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'BetaNonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +Enum representing the type of data a schema attribute accepts. + +## Enum + +* `TEXT` (value: `'TEXT'`) + +* `DATE` (value: `'DATE'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSource.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSource.md new file mode 100644 index 000000000..b2dea93ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSource.md @@ -0,0 +1,57 @@ +--- +id: beta-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSource', 'BetaNonEmployeeSource'] +slug: /tools/sdk/python/beta/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'BetaNonEmployeeSource'] +--- + +# NonEmployeeSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_count** | **int** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_source import NonEmployeeSource + +non_employee_source = NonEmployeeSource( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..ca4e7a154 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceLite.md @@ -0,0 +1,39 @@ +--- +id: beta-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceLite', 'BetaNonEmployeeSourceLite'] +slug: /tools/sdk/python/beta/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'BetaNonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_source_lite import NonEmployeeSourceLite + +non_employee_source_lite = NonEmployeeSourceLite( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..64baa1a31 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,53 @@ +--- +id: beta-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'BetaNonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/python/beta/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'BetaNonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**schema_attributes** | [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_source_lite_with_schema_attributes import NonEmployeeSourceLiteWithSchemaAttributes + +non_employee_source_lite_with_schema_attributes = NonEmployeeSourceLiteWithSchemaAttributes( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +schema_attributes=[ + sailpoint.beta.models.non_employee_schema_attribute.NonEmployeeSchemaAttribute( + id = 'ac110005-7156-1150-8171-5b292e3e0084', + system = True, + modified = '2019-08-23T18:52:59.162Z', + created = '2019-08-23T18:40:35.772Z', + type = 'TEXT', + label = 'Account Name', + technical_name = 'account.name', + help_text = 'The unique identifier for the account', + placeholder = 'Enter a unique user name for this account.', + required = True, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..439807d56 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,50 @@ +--- +id: beta-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceRequestBody', 'BetaNonEmployeeSourceRequestBody'] +slug: /tools/sdk/python/beta/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'BetaNonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of non-employee source. | [required] +**description** | **str** | Description of non-employee source. | [required] +**owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] +**management_workgroup** | **str** | The ID for the management workgroup that contains source sub-admins | [optional] +**approvers** | [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**account_managers** | [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_source_request_body import NonEmployeeSourceRequestBody + +non_employee_source_request_body = NonEmployeeSourceRequestBody( +name='Retail', +description='Source description', +owner=sailpoint.beta.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ), +management_workgroup='123299', +approvers=[ + sailpoint.beta.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ) + ], +account_managers=[ + sailpoint.beta.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..7517e2b6a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,59 @@ +--- +id: beta-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'BetaNonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/python/beta/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'BetaNonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_count** | **int** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +**cloud_external_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId + +non_employee_source_with_cloud_external_id = NonEmployeeSourceWithCloudExternalId( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_count=2, +cloud_external_id='99999' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..cce48d81a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,57 @@ +--- +id: beta-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceWithNECount', 'BetaNonEmployeeSourceWithNECount'] +slug: /tools/sdk/python/beta/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'BetaNonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_count** | **int** | 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'. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount + +non_employee_source_with_ne_count = NonEmployeeSourceWithNECount( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.beta.models.identity_reference_with_id.IdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/NotificationTemplateContext.md b/docs/tools/sdk/python/Reference/Beta/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..72e825ed9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/NotificationTemplateContext.md @@ -0,0 +1,37 @@ +--- +id: beta-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NotificationTemplateContext', 'BetaNotificationTemplateContext'] +slug: /tools/sdk/python/beta/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'BetaNotificationTemplateContext'] +--- + +# NotificationTemplateContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **map[string]object** | A JSON object that stores the context. | [optional] +**created** | **datetime** | When the global context was created | [optional] +**modified** | **datetime** | When the global context was last modified | [optional] +} + +## Example + +```python +from sailpoint.beta.models.notification_template_context import NotificationTemplateContext + +notification_template_context = NotificationTemplateContext( +attributes={productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}}, +created='2020-04-15T16:16:47.525Z', +modified='2020-04-15T16:16:47.525Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ObjectExportImportOptions.md b/docs/tools/sdk/python/Reference/Beta/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..37e7436c7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ObjectExportImportOptions.md @@ -0,0 +1,39 @@ +--- +id: beta-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectExportImportOptions', 'BetaObjectExportImportOptions'] +slug: /tools/sdk/python/beta/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'BetaObjectExportImportOptions'] +--- + +# ObjectExportImportOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**included_ids** | **[]str** | Object ids to be included in an import or export. | [optional] +**included_names** | **[]str** | Object names to be included in an import or export. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.object_export_import_options import ObjectExportImportOptions + +object_export_import_options = ObjectExportImportOptions( +included_ids=[ + 'be9e116d-08e1-49fc-ab7f-fa585e96c9e4' + ], +included_names=[ + 'Test Object' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ObjectImportResult.md b/docs/tools/sdk/python/Reference/Beta/Models/ObjectImportResult.md new file mode 100644 index 000000000..a023c269c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ObjectImportResult.md @@ -0,0 +1,60 @@ +--- +id: beta-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectImportResult', 'BetaObjectImportResult'] +slug: /tools/sdk/python/beta/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'BetaObjectImportResult'] +--- + +# ObjectImportResult + +Response model for import of a single object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] +**warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] +**errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] +**imported_objects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] +} + +## Example + +```python +from sailpoint.beta.models.object_import_result import ObjectImportResult + +object_import_result = ObjectImportResult( +infos=[ + sailpoint.beta.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +warnings=[ + sailpoint.beta.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +errors=[ + sailpoint.beta.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +imported_objects=[ + sailpoint.beta.models.import_object.ImportObject( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OktaVerificationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/OktaVerificationRequest.md new file mode 100644 index 000000000..9c45ee695 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OktaVerificationRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-okta-verification-request +title: OktaVerificationRequest +pagination_label: OktaVerificationRequest +sidebar_label: OktaVerificationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OktaVerificationRequest', 'BetaOktaVerificationRequest'] +slug: /tools/sdk/python/beta/models/okta-verification-request +tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest', 'BetaOktaVerificationRequest'] +--- + +# OktaVerificationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | User identifier for Verification request. The value of the user's attribute. | [required] +} + +## Example + +```python +from sailpoint.beta.models.okta_verification_request import OktaVerificationRequest + +okta_verification_request = OktaVerificationRequest( +user_id='example@mail.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OrgConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/OrgConfig.md new file mode 100644 index 000000000..11985d3fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OrgConfig.md @@ -0,0 +1,58 @@ +--- +id: beta-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OrgConfig', 'BetaOrgConfig'] +slug: /tools/sdk/python/beta/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig'] +--- + +# OrgConfig + +DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**org_name** | **str** | The name of the org. | [optional] +**time_zone** | **str** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**lcs_change_honors_source_enable_feature** | **bool** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**arm_customer_id** | **str** | ARM Customer ID | [optional] +**arm_sap_system_id_mappings** | **str** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**arm_auth** | **str** | ARM authentication string | [optional] +**arm_db** | **str** | ARM database name | [optional] +**arm_sso_url** | **str** | ARM SSO URL | [optional] +**iai_enable_certification_recommendations** | **bool** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**sod_report_configs** | [**[]ReportConfigDTO**](report-config-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.org_config import OrgConfig + +org_config = OrgConfig( +org_name='acme-solar', +time_zone='America/Toronto', +lcs_change_honors_source_enable_feature=False, +arm_customer_id='DE38E75A-5FF6-4A65-5DC7-08D64426B09E', +arm_sap_system_id_mappings='[{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}]', +arm_auth='epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag==', +arm_db='EU', +arm_sso_url='https://your-arm-sso-url', +iai_enable_certification_recommendations=True, +sod_report_configs=[ + sailpoint.beta.models.report_config_dto.ReportConfigDTO( + column_name = 'SOD Business Name', + required = True, + included = False, + order = 2, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Outlier.md b/docs/tools/sdk/python/Reference/Beta/Models/Outlier.md new file mode 100644 index 000000000..d8eb19cfc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Outlier.md @@ -0,0 +1,53 @@ +--- +id: beta-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Outlier', 'BetaOutlier'] +slug: /tools/sdk/python/beta/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'BetaOutlier'] +--- + +# Outlier + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity's unique identifier for the outlier record | [optional] +**identity_id** | **str** | The ID of the identity that is detected as an outlier | [optional] +**type** | **Enum** [ 'LOW_SIMILARITY', 'STRUCTURAL' ] | The type of outlier summary | [optional] +**first_detection_date** | **datetime** | The first date the outlier was detected | [optional] +**latest_detection_date** | **datetime** | The most recent date the outlier was detected | [optional] +**ignored** | **bool** | Flag whether or not the outlier has been ignored | [optional] +**attributes** | **object** | Object containing mapped identity attributes | [optional] +**score** | **float** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**unignore_type** | **Enum** [ 'MANUAL', 'AUTOMATIC' ] | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**unignore_date** | **datetime** | shows date when last time has been unignored outlier | [optional] +**ignore_date** | **datetime** | shows date when last time has been ignored outlier | [optional] +} + +## Example + +```python +from sailpoint.beta.models.outlier import Outlier + +outlier = Outlier( +id='5be33d3e-c54d-4ed7-af73-2380543e8283', +identity_id='5be33d3e-c54d-4ed7-af73-2380543e8283', +type='LOW_SIMILARITY', +first_detection_date='2021-05-01T18:40:35.772Z', +latest_detection_date='2021-05-03T18:40:35.772Z', +ignored=False, +attributes={displayName=John Smith, jobTitle=Software Engineer, department=Engineering}, +score=0.92, +unignore_type='MANUAL', +unignore_date='2021-06-01T18:40:35.772Z', +ignore_date='2021-06-01T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutlierContributingFeature.md b/docs/tools/sdk/python/Reference/Beta/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..3303c6ac3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutlierContributingFeature.md @@ -0,0 +1,53 @@ +--- +id: beta-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierContributingFeature', 'BetaOutlierContributingFeature'] +slug: /tools/sdk/python/beta/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'BetaOutlierContributingFeature'] +--- + +# OutlierContributingFeature + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Contributing feature id | [optional] +**name** | **str** | The name of the feature | [optional] +**value_type** | **Enum** [ 'INTEGER', 'FLOAT' ] | The data type of the value field | [optional] +**value** | [**OutlierContributingFeatureValue**](outlier-contributing-feature-value) | | [optional] +**importance** | **float** | The importance of the feature. This can also be a negative value | [optional] +**display_name** | **str** | The (translated if header is passed) displayName for the feature | [optional] +**description** | **str** | The (translated if header is passed) description for the feature | [optional] +**translation_messages** | [**OutlierFeatureTranslation**](outlier-feature-translation) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.outlier_contributing_feature import OutlierContributingFeature + +outlier_contributing_feature = OutlierContributingFeature( +id='66e38828-5017-47af-92ff-9844871352c5', +name='entitlement_count', +value_type='INTEGER', +value=0.92, +importance=-0.15, +display_name='Number of entitlements', +description='The total number of entitlements belonging to an identity', +translation_messages=sailpoint.beta.models.outlier_feature_translation.OutlierFeatureTranslation( + display_name = sailpoint.beta.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ), + description = sailpoint.beta.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutlierContributingFeatureValue.md b/docs/tools/sdk/python/Reference/Beta/Models/OutlierContributingFeatureValue.md new file mode 100644 index 000000000..39c880a77 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutlierContributingFeatureValue.md @@ -0,0 +1,32 @@ +--- +id: beta-outlier-contributing-feature-value +title: OutlierContributingFeatureValue +pagination_label: OutlierContributingFeatureValue +sidebar_label: OutlierContributingFeatureValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierContributingFeatureValue', 'BetaOutlierContributingFeatureValue'] +slug: /tools/sdk/python/beta/models/outlier-contributing-feature-value +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeatureValue', 'BetaOutlierContributingFeatureValue'] +--- + +# OutlierContributingFeatureValue + +The feature value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.outlier_contributing_feature_value import OutlierContributingFeatureValue + +outlier_contributing_feature_value = OutlierContributingFeatureValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..9330e7d5f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureSummary.md @@ -0,0 +1,52 @@ +--- +id: beta-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierFeatureSummary', 'BetaOutlierFeatureSummary'] +slug: /tools/sdk/python/beta/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'BetaOutlierFeatureSummary'] +--- + +# OutlierFeatureSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contributing_feature_name** | **str** | Contributing feature name | [optional] +**identity_outlier_display_name** | **str** | Identity display name | [optional] +**outlier_feature_display_values** | [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**feature_definition** | **str** | Definition of the feature | [optional] +**feature_explanation** | **str** | Detailed explanation of the feature | [optional] +**peer_display_name** | **str** | outlier's peer identity display name | [optional] +**peer_identity_id** | **str** | outlier's peer identity id | [optional] +**access_item_reference** | **object** | Access Item reference | [optional] +} + +## Example + +```python +from sailpoint.beta.models.outlier_feature_summary import OutlierFeatureSummary + +outlier_feature_summary = OutlierFeatureSummary( +contributing_feature_name='Rare Access', +identity_outlier_display_name='John Smith', +outlier_feature_display_values=[ + sailpoint.beta.models.outlier_feature_summary_outlier_feature_display_values_inner.OutlierFeatureSummary_outlierFeatureDisplayValues_inner( + display_name = 'Aliza Chris', + value = '55', + value_type = 'INTEGER', ) + ], +feature_definition='Identity total number of entitlements', +feature_explanation='An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess', +peer_display_name='Mary Jane', +peer_identity_id='9f9d5d53ad0e48fba7352f6da9f1b8gbg', +access_item_reference={displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..ff84cda2b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,37 @@ +--- +id: beta-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/python/beta/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_name** | **str** | display name | [optional] +**value** | **str** | value | [optional] +**value_type** | **Enum** [ 'INTEGER', 'FLOAT' ] | The data type of the value field | [optional] +} + +## Example + +```python +from sailpoint.beta.models.outlier_feature_summary_outlier_feature_display_values_inner import OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +outlier_feature_summary_outlier_feature_display_values_inner = OutlierFeatureSummaryOutlierFeatureDisplayValuesInner( +display_name='Aliza Chris', +value='55', +value_type='INTEGER' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..ea4b65570 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutlierFeatureTranslation.md @@ -0,0 +1,39 @@ +--- +id: beta-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierFeatureTranslation', 'BetaOutlierFeatureTranslation'] +slug: /tools/sdk/python/beta/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'BetaOutlierFeatureTranslation'] +--- + +# OutlierFeatureTranslation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_name** | [**TranslationMessage**](translation-message) | | [optional] +**description** | [**TranslationMessage**](translation-message) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.outlier_feature_translation import OutlierFeatureTranslation + +outlier_feature_translation = OutlierFeatureTranslation( +display_name=sailpoint.beta.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ), +description=sailpoint.beta.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutlierSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/OutlierSummary.md new file mode 100644 index 000000000..78dceca67 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutlierSummary.md @@ -0,0 +1,41 @@ +--- +id: beta-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierSummary', 'BetaOutlierSummary'] +slug: /tools/sdk/python/beta/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'BetaOutlierSummary'] +--- + +# OutlierSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LOW_SIMILARITY', 'STRUCTURAL' ] | The type of outlier summary | [optional] +**snapshot_date** | **datetime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**total_outliers** | **int** | Total number of outliers for the customer making the request | [optional] +**total_identities** | **int** | Total number of identities for the customer making the request | [optional] +**total_ignored** | **int** | | [optional] [default to 0] +} + +## Example + +```python +from sailpoint.beta.models.outlier_summary import OutlierSummary + +outlier_summary = OutlierSummary( +type='LOW_SIMILARITY', +snapshot_date='2021-05-01T18:40:35.772Z', +total_outliers=50, +total_identities=5000, +total_ignored=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/python/Reference/Beta/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..c71b63bb6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,43 @@ +--- +id: beta-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutliersContributingFeatureAccessItems', 'BetaOutliersContributingFeatureAccessItems'] +slug: /tools/sdk/python/beta/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'BetaOutliersContributingFeatureAccessItems'] +--- + +# OutliersContributingFeatureAccessItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the access item | [optional] +**display_name** | **str** | the display name of the access item | [optional] +**description** | **str** | Description of the access item. | [optional] +**access_type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | The type of the access item. | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**extremely_rare** | **bool** | rarest access | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems + +outliers_contributing_feature_access_items = OutliersContributingFeatureAccessItems( +id='2c938083633d259901633d2623ec0375', +display_name='Applied Research Access', +description='Access to research information, lab results, and schematics', +access_type='ENTITLEMENT', +source_name='appName', +extremely_rare=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OwnerDto.md b/docs/tools/sdk/python/Reference/Beta/Models/OwnerDto.md new file mode 100644 index 000000000..3a2f44f52 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OwnerDto.md @@ -0,0 +1,38 @@ +--- +id: beta-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerDto', 'BetaOwnerDto'] +slug: /tools/sdk/python/beta/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'BetaOwnerDto'] +--- + +# OwnerDto + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.owner_dto import OwnerDto + +owner_dto = OwnerDto( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md new file mode 100644 index 000000000..b1a989e36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md @@ -0,0 +1,38 @@ +--- +id: beta-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReference', 'BetaOwnerReference'] +slug: /tools/sdk/python/beta/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference'] +--- + +# OwnerReference + +The owner of this object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.owner_reference import OwnerReference + +owner_reference = OwnerReference( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReferenceDto.md b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReferenceDto.md new file mode 100644 index 000000000..8dc8c7d3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReferenceDto.md @@ -0,0 +1,38 @@ +--- +id: beta-owner-reference-dto +title: OwnerReferenceDto +pagination_label: OwnerReferenceDto +sidebar_label: OwnerReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReferenceDto', 'BetaOwnerReferenceDto'] +slug: /tools/sdk/python/beta/models/owner-reference-dto +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceDto', 'BetaOwnerReferenceDto'] +--- + +# OwnerReferenceDto + +Simplified DTO for the owner object of the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The owner id for the entitlement | [optional] +**name** | **str** | The owner name for the entitlement | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the owner. Initially only type IDENTITY is supported | [optional] +} + +## Example + +```python +from sailpoint.beta.models.owner_reference_dto import OwnerReferenceDto + +owner_reference_dto = OwnerReferenceDto( +id='2a2fdacca5e345f18bf7970cfbb8fec2', +name='identity 1', +type='IDENTITY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReferenceSegments.md b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..c87d5e5b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReferenceSegments.md @@ -0,0 +1,38 @@ +--- +id: beta-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReferenceSegments', 'BetaOwnerReferenceSegments'] +slug: /tools/sdk/python/beta/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'BetaOwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +The owner of this object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.owner_reference_segments import OwnerReferenceSegments + +owner_reference_segments = OwnerReferenceSegments( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordChangeRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..7c4221264 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordChangeRequest.md @@ -0,0 +1,41 @@ +--- +id: beta-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordChangeRequest', 'BetaPasswordChangeRequest'] +slug: /tools/sdk/python/beta/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'BetaPasswordChangeRequest'] +--- + +# PasswordChangeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID that requested the password change | [optional] +**encrypted_password** | **str** | The RSA encrypted password | [optional] +**public_key_id** | **str** | The encryption key ID | [optional] +**account_id** | **str** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**source_id** | **str** | The ID of the source for which identity is requesting the password change | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_change_request import PasswordChangeRequest + +password_change_request = PasswordChangeRequest( +identity_id='8a807d4c73c545510173c545f0a002ff', +encrypted_password='XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==', +public_key_id='YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2', +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +source_id='8a807d4c73c545510173c545d4b60246' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordChangeResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..7c9652df1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordChangeResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordChangeResponse', 'BetaPasswordChangeResponse'] +slug: /tools/sdk/python/beta/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'BetaPasswordChangeResponse'] +--- + +# PasswordChangeResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The password change request ID | [optional] +**state** | **Enum** [ 'IN_PROGRESS', 'FINISHED', 'FAILED' ] | Password change state | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_change_response import PasswordChangeResponse + +password_change_response = PasswordChangeResponse( +request_id='089899f13a8f4da7824996191587bab9', +state='IN_PROGRESS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordDigitToken.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordDigitToken.md new file mode 100644 index 000000000..41446180a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordDigitToken.md @@ -0,0 +1,35 @@ +--- +id: beta-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordDigitToken', 'BetaPasswordDigitToken'] +slug: /tools/sdk/python/beta/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'BetaPasswordDigitToken'] +--- + +# PasswordDigitToken + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**digit_token** | **str** | The digit token for password management | [optional] +**request_id** | **str** | The reference ID of the digit token generation request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_digit_token import PasswordDigitToken + +password_digit_token = PasswordDigitToken( +digit_token='09087713', +request_id='e1267ecd-fcd9-4c73-9c55-12555efad136' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..ad9cd5af5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordDigitTokenReset.md @@ -0,0 +1,37 @@ +--- +id: beta-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordDigitTokenReset', 'BetaPasswordDigitTokenReset'] +slug: /tools/sdk/python/beta/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'BetaPasswordDigitTokenReset'] +--- + +# PasswordDigitTokenReset + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | The uid of the user requested for digit token | [required] +**length** | **int** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**duration_minutes** | **int** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_digit_token_reset import PasswordDigitTokenReset + +password_digit_token_reset = PasswordDigitTokenReset( +user_id='Abby.Smith', +length=8, +duration_minutes=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfo.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfo.md new file mode 100644 index 000000000..c29dcff3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfo.md @@ -0,0 +1,47 @@ +--- +id: beta-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfo', 'BetaPasswordInfo'] +slug: /tools/sdk/python/beta/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'BetaPasswordInfo'] +--- + +# PasswordInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | | [optional] +**source_id** | **str** | | [optional] +**public_key_id** | **str** | | [optional] +**public_key** | **str** | User's public key with Base64 encoding | [optional] +**accounts** | [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**policies** | **[]str** | Password constraints | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_info import PasswordInfo + +password_info = PasswordInfo( +identity_id='2c918085744fec4301746f9a5bce4605', +source_id='2c918083746f642c01746f990884012a', +public_key_id='N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh', +public_key='MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB', +accounts=[ + sailpoint.beta.models.password_info_account.PasswordInfoAccount( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + account_name = 'Abby.Smith', ) + ], +policies=[passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfoAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..223f166e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfoAccount.md @@ -0,0 +1,35 @@ +--- +id: beta-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfoAccount', 'BetaPasswordInfoAccount'] +slug: /tools/sdk/python/beta/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'BetaPasswordInfoAccount'] +--- + +# PasswordInfoAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**account_name** | **str** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_info_account import PasswordInfoAccount + +password_info_account = PasswordInfoAccount( +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +account_name='Abby.Smith' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..0748b32de --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,35 @@ +--- +id: beta-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfoQueryDTO', 'BetaPasswordInfoQueryDTO'] +slug: /tools/sdk/python/beta/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'BetaPasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | The login name of the user | [optional] +**source_name** | **str** | The display name of the source | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_info_query_dto import PasswordInfoQueryDTO + +password_info_query_dto = PasswordInfoQueryDTO( +user_name='Abby.Smith', +source_name='My-AD' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordOrgConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..783ef88d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordOrgConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordOrgConfig', 'BetaPasswordOrgConfig'] +slug: /tools/sdk/python/beta/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'BetaPasswordOrgConfig'] +--- + +# PasswordOrgConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**custom_instructions_enabled** | **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to False] +**digit_token_enabled** | **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to False] +**digit_token_duration_minutes** | **int** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**digit_token_length** | **int** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] +} + +## Example + +```python +from sailpoint.beta.models.password_org_config import PasswordOrgConfig + +password_org_config = PasswordOrgConfig( +custom_instructions_enabled=True, +digit_token_enabled=True, +digit_token_duration_minutes=10, +digit_token_length=9 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..2244592c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,93 @@ +--- +id: beta-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordPolicyV3Dto', 'BetaPasswordPolicyV3Dto'] +slug: /tools/sdk/python/beta/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'BetaPasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The password policy Id. | [optional] +**description** | **str** | Description for current password policy. | [optional] +**name** | **str** | The name of the password policy. | [optional] +**date_created** | **datetime** | Date the Password Policy was created. | [optional] +**last_updated** | **datetime** | Date the Password Policy was updated. | [optional] +**first_expiration_reminder** | **int** | The number of days before expiration remaninder. | [optional] +**account_id_min_word_length** | **int** | The minimun length of account Id. By default is equals to -1. | [optional] +**account_name_min_word_length** | **int** | The minimun length of account name. By default is equals to -1. | [optional] +**min_alpha** | **int** | Maximum alpha. By default is equals to 0. | [optional] +**min_character_types** | **int** | MinCharacterTypes. By default is equals to -1. | [optional] +**max_length** | **int** | Maximum length of the password. | [optional] +**min_length** | **int** | Minimum length of the password. By default is equals to 0. | [optional] +**max_repeated_chars** | **int** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**min_lower** | **int** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**min_numeric** | **int** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**min_special** | **int** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**min_upper** | **int** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**password_expiration** | **int** | Number of days before current password expires. By default is equals to 90. | [optional] +**default_policy** | **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to False] +**enable_passwd_expiration** | **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to False] +**require_strong_authn** | **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to False] +**require_strong_auth_off_network** | **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to False] +**require_strong_auth_untrusted_geographies** | **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to False] +**use_account_attributes** | **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to False] +**use_dictionary** | **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to False] +**use_identity_attributes** | **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to False] +**validate_against_account_id** | **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to False] +**validate_against_account_name** | **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to False] +**created** | **str** | | [optional] +**modified** | **str** | | [optional] +**source_ids** | **[]str** | List of sources IDs managed by this password policy. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto + +password_policy_v3_dto = PasswordPolicyV3Dto( +id='2c91808e7d976f3b017d9f5ceae440c8', +description='Information about the Password Policy', +name='PasswordPolicy Example', +date_created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +last_updated=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +first_expiration_reminder=45, +account_id_min_word_length=4, +account_name_min_word_length=6, +min_alpha=5, +min_character_types=5, +max_length=25, +min_length=8, +max_repeated_chars=3, +min_lower=8, +min_numeric=8, +min_special=8, +min_upper=8, +password_expiration=8, +default_policy=True, +enable_passwd_expiration=True, +require_strong_authn=True, +require_strong_auth_off_network=True, +require_strong_auth_untrusted_geographies=True, +use_account_attributes=False, +use_dictionary=False, +use_identity_attributes=False, +validate_against_account_id=False, +validate_against_account_name=True, +created='', +modified='', +source_ids=[2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordStatus.md new file mode 100644 index 000000000..b9ce4d452 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordStatus.md @@ -0,0 +1,43 @@ +--- +id: beta-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordStatus', 'BetaPasswordStatus'] +slug: /tools/sdk/python/beta/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'BetaPasswordStatus'] +--- + +# PasswordStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The password change request ID | [optional] +**state** | **Enum** [ 'IN_PROGRESS', 'FINISHED', 'FAILED' ] | Password change state | [optional] +**errors** | **[]str** | The errors during the password change request | [optional] +**source_ids** | **[]str** | List of source IDs in the password change request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_status import PasswordStatus + +password_status = PasswordStatus( +request_id='089899f13a8f4da7824996191587bab9', +state='IN_PROGRESS', +errors=[ + '' + ], +source_ids=[ + '' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PasswordSyncGroup.md b/docs/tools/sdk/python/Reference/Beta/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..8ed5560cb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PasswordSyncGroup.md @@ -0,0 +1,43 @@ +--- +id: beta-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordSyncGroup', 'BetaPasswordSyncGroup'] +slug: /tools/sdk/python/beta/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'BetaPasswordSyncGroup'] +--- + +# PasswordSyncGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the sync group | [optional] +**name** | **str** | Name of the sync group | [optional] +**password_policy_id** | **str** | ID of the password policy | [optional] +**source_ids** | **[]str** | List of password managed sources IDs | [optional] +**created** | **datetime** | The date and time this sync group was created | [optional] +**modified** | **datetime** | The date and time this sync group was last modified | [optional] +} + +## Example + +```python +from sailpoint.beta.models.password_sync_group import PasswordSyncGroup + +password_sync_group = PasswordSyncGroup( +id='6881f631-3bd5-4213-9c75-8e05cc3e35dd', +name='Password Sync Group 1', +password_policy_id='2c91808d744ba0ce01746f93b6204501', +source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], +created='2023-03-16T04:00Z', +modified='2023-03-16T04:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PatOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/PatOwner.md new file mode 100644 index 000000000..4dc6c5135 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PatOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatOwner', 'BetaPatOwner'] +slug: /tools/sdk/python/beta/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'BetaPatOwner'] +--- + +# PatOwner + +Personal access token owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Personal access token owner's DTO type. | [optional] +**id** | **str** | Personal access token owner's identity ID. | [optional] +**name** | **str** | Personal access token owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.pat_owner import PatOwner + +pat_owner = PatOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/python/Reference/Beta/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..cde655b1f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,37 @@ +--- +id: beta-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatchPotentialRoleRequestInner', 'BetaPatchPotentialRoleRequestInner'] +slug: /tools/sdk/python/beta/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'BetaPatchPotentialRoleRequestInner'] +--- + +# PatchPotentialRoleRequestInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'remove', 'replace' ] | The operation to be performed | [optional] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner + +patch_potential_role_request_inner = PatchPotentialRoleRequestInner( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md new file mode 100644 index 000000000..6e677f1f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md @@ -0,0 +1,39 @@ +--- +id: beta-patch-service-desk-integration-request +title: PatchServiceDeskIntegrationRequest +pagination_label: PatchServiceDeskIntegrationRequest +sidebar_label: PatchServiceDeskIntegrationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] +slug: /tools/sdk/python/beta/models/patch-service-desk-integration-request +tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] +--- + +# PatchServiceDeskIntegrationRequest + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] +} + +## Example + +```python +from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + +patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( +operations=[ + sailpoint.beta.models.json_patch_operation.JsonPatchOperation( + op = 'replace', + path = '/description', + value = New description, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PeerGroupMember.md b/docs/tools/sdk/python/Reference/Beta/Models/PeerGroupMember.md new file mode 100644 index 000000000..99af9f685 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PeerGroupMember.md @@ -0,0 +1,41 @@ +--- +id: beta-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PeerGroupMember', 'BetaPeerGroupMember'] +slug: /tools/sdk/python/beta/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'BetaPeerGroupMember'] +--- + +# PeerGroupMember + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier for the peer group member. | [optional] +**type** | **str** | The type of the peer group member. | [optional] +**peer_group_id** | **str** | The ID of the peer group. | [optional] +**attributes** | **map[string]object** | Arbitrary key-value pairs, belonging to the peer group member. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.peer_group_member import PeerGroupMember + +peer_group_member = PeerGroupMember( +id='', +type='', +peer_group_id='', +attributes={ + 'key' : None + } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PendingApproval.md b/docs/tools/sdk/python/Reference/Beta/Models/PendingApproval.md new file mode 100644 index 000000000..864b03390 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PendingApproval.md @@ -0,0 +1,134 @@ +--- +id: beta-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApproval', 'BetaPendingApproval'] +slug: /tools/sdk/python/beta/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'BetaPendingApproval'] +--- + +# PendingApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval id. | [optional] +**name** | **str** | The name of the approval. | [optional] +**created** | **datetime** | When the approval was created. | [optional] +**modified** | **datetime** | When the approval was modified last time. | [optional] +**request_created** | **datetime** | When the access-request was created. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requester** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] +**requested_for** | [**AccessItemRequestedForDto**](access-item-requested-for-dto) | | [optional] +**owner** | [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] +**requested_object** | [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**requester_comment** | [**CommentDto1**](comment-dto1) | | [optional] +**previous_reviewers_comments** | [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**comment_required_when_rejected** | **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to False] +**action_in_process** | [**PendingApprovalAction**](pending-approval-action) | | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**remove_date_update_requested** | **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to False] +**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**sod_violation_context** | [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.pending_approval import PendingApproval + +pending_approval = PendingApproval( +id='2c9180835d2e5168015d32f890ca1581', +name='Pending approval name', +created='2017-07-11T18:45:37.098Z', +modified='2018-07-25T20:22:28.104Z', +request_created='2017-07-11T18:45:35.098Z', +request_type='GRANT_ACCESS', +requester=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ), +owner=sailpoint.beta.models.access_item_owner_dto.AccessItemOwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +requested_object=sailpoint.beta.models.requestable_object_reference.RequestableObjectReference( + id = '2c938083633d259901633d25c68c00fa', + name = 'Object Name', + description = 'Object Description', + type = 'ROLE', ), +requester_comment=sailpoint.beta.models.comment_dto_1.CommentDto_1( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.beta.models.comment_dto_1_author.CommentDto_1_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ), +previous_reviewers_comments=[ + sailpoint.beta.models.comment_dto_1.CommentDto_1( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.beta.models.comment_dto_1_author.CommentDto_1_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ) + ], +forward_history=[ + sailpoint.beta.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], +comment_required_when_rejected=True, +action_in_process='APPROVED', +remove_date='2020-07-11T00:00Z', +remove_date_update_requested=True, +current_remove_date='2020-07-11T00:00Z', +sod_violation_context=sailpoint.beta.models.sod_violation_context_check_completed_1.SodViolationContextCheckCompleted_1( + state = 'SUCCESS', + uuid = 'f73d16e9-a038-46c5-b217-1246e15fdbdd', + violation_check_result = sailpoint.beta.models.sod_violation_check_result_1.SodViolationCheckResult_1( + message = sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.beta.models.sod_violation_context_1.SodViolationContext_1( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PendingApprovalAction.md b/docs/tools/sdk/python/Reference/Beta/Models/PendingApprovalAction.md new file mode 100644 index 000000000..087a44e0d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PendingApprovalAction.md @@ -0,0 +1,25 @@ +--- +id: beta-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApprovalAction', 'BetaPendingApprovalAction'] +slug: /tools/sdk/python/beta/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'BetaPendingApprovalAction'] +--- + +# PendingApprovalAction + +Enum represents action that is being processed on an approval. + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `FORWARDED` (value: `'FORWARDED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PermissionDto.md b/docs/tools/sdk/python/Reference/Beta/Models/PermissionDto.md new file mode 100644 index 000000000..3e3f1af98 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PermissionDto.md @@ -0,0 +1,38 @@ +--- +id: beta-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PermissionDto', 'BetaPermissionDto'] +slug: /tools/sdk/python/beta/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'BetaPermissionDto'] +--- + +# PermissionDto + +Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**target** | **str** | The target the permission would grants rights on. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.permission_dto import PermissionDto + +permission_dto = PermissionDto( +rights=[ + 'SELECT' + ], +target='SYS.GV_$TRANSACTION' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PostExternalExecuteWorkflow200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/PostExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..284d1ce56 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PostExternalExecuteWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: beta-post-external-execute-workflow200-response +title: PostExternalExecuteWorkflow200Response +pagination_label: PostExternalExecuteWorkflow200Response +sidebar_label: PostExternalExecuteWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PostExternalExecuteWorkflow200Response', 'BetaPostExternalExecuteWorkflow200Response'] +slug: /tools/sdk/python/beta/models/post-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflow200Response', 'BetaPostExternalExecuteWorkflow200Response'] +--- + +# PostExternalExecuteWorkflow200Response + + +## 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.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response + +post_external_execute_workflow200_response = PostExternalExecuteWorkflow200Response( +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/Beta/Models/PostExternalExecuteWorkflowRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..f679a026f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-post-external-execute-workflow-request +title: PostExternalExecuteWorkflowRequest +pagination_label: PostExternalExecuteWorkflowRequest +sidebar_label: PostExternalExecuteWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PostExternalExecuteWorkflowRequest', 'BetaPostExternalExecuteWorkflowRequest'] +slug: /tools/sdk/python/beta/models/post-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflowRequest', 'BetaPostExternalExecuteWorkflowRequest'] +--- + +# PostExternalExecuteWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The input for the workflow | [optional] +} + +## Example + +```python +from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest + +post_external_execute_workflow_request = PostExternalExecuteWorkflowRequest( +input={customAttribute1=value1, customAttribute2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..1091edba7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,38 @@ +--- +id: beta-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreApprovalTriggerDetails', 'BetaPreApprovalTriggerDetails'] +slug: /tools/sdk/python/beta/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'BetaPreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +Provides additional details about the pre-approval trigger for this request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment left for the pre-approval decision | [optional] +**reviewer** | **str** | The reviewer of the pre-approval decision | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | The decision of the pre-approval trigger | [optional] +} + +## Example + +```python +from sailpoint.beta.models.pre_approval_trigger_details import PreApprovalTriggerDetails + +pre_approval_trigger_details = PreApprovalTriggerDetails( +comment='Access is Approved', +reviewer='John Doe', +decision='APPROVED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PreferencesDto.md b/docs/tools/sdk/python/Reference/Beta/Models/PreferencesDto.md new file mode 100644 index 000000000..05ac5454b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PreferencesDto.md @@ -0,0 +1,38 @@ +--- +id: beta-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreferencesDto', 'BetaPreferencesDto'] +slug: /tools/sdk/python/beta/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'BetaPreferencesDto'] +--- + +# PreferencesDto + +Maps an Identity's attribute key to a list of preferred notification mediums. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The template notification key. | [optional] +**mediums** | [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**modified** | **datetime** | Modified date of preference | [optional] +} + +## Example + +```python +from sailpoint.beta.models.preferences_dto import PreferencesDto + +preferences_dto = PreferencesDto( +key='cloud_manual_work_item_summary', +mediums=[EMAIL], +modified='2020-05-15T14:37:06.909Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..b6cd601ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PreviewDataSourceResponse.md @@ -0,0 +1,34 @@ +--- +id: beta-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreviewDataSourceResponse', 'BetaPreviewDataSourceResponse'] +slug: /tools/sdk/python/beta/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'BetaPreviewDataSourceResponse'] +--- + +# PreviewDataSourceResponse + +PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] +} + +## Example + +```python +from sailpoint.beta.models.preview_data_source_response import PreviewDataSourceResponse + +preview_data_source_response = PreviewDataSourceResponse( +results={"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"}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..aff601fdf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProcessIdentitiesRequest', 'BetaProcessIdentitiesRequest'] +slug: /tools/sdk/python/beta/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'BetaProcessIdentitiesRequest'] +--- + +# ProcessIdentitiesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_ids** | **[]str** | List of up to 250 identity IDs to process. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.process_identities_request import ProcessIdentitiesRequest + +process_identities_request = ProcessIdentitiesRequest( +identity_ids=[ + 'ef38f94347e94562b5bb8424a56397d8' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Product.md b/docs/tools/sdk/python/Reference/Beta/Models/Product.md new file mode 100644 index 000000000..f686c8fc2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Product.md @@ -0,0 +1,67 @@ +--- +id: beta-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Product', 'BetaProduct'] +slug: /tools/sdk/python/beta/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'BetaProduct'] +--- + +# Product + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_name** | **str** | Name of the Product | [optional] +**url** | **str** | URL of the Product | [optional] +**product_tenant_id** | **str** | An identifier for a specific product-tenant combination | [optional] +**product_region** | **str** | Product region | [optional] +**product_right** | **str** | Right needed for the Product | [optional] +**api_url** | **str** | API URL of the Product | [optional] +**licenses** | [**[]License**](license) | | [optional] +**attributes** | **map[string]object** | Additional attributes for a product | [optional] +**zone** | **str** | Zone | [optional] +**status** | **str** | Status of the product | [optional] +**status_date_time** | **datetime** | Status datetime | [optional] +**reason** | **str** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**notes** | **str** | Product could have additional notes added during tenant provisioning. | [optional] +**date_created** | **datetime** | Date when the product was created | [optional] +**last_updated** | **datetime** | Date when the product was last updated | [optional] +**org_type** | **Enum** [ 'development', 'staging', 'production', 'test', 'partner', 'training', 'demonstration', 'sandbox' ] | Type of org | [optional] +} + +## Example + +```python +from sailpoint.beta.models.product import Product + +product = Product( +product_name='idn', +url='https://tenant-name.identitynow.com', +product_tenant_id='tenant#product', +product_region='us-east-1', +product_right='idn:ui:view', +api_url='https://tenant-name.api.identitynow.com', +licenses=[ + sailpoint.beta.models.license.License( + license_id = 'idn:access-request', + legacy_feature_name = 'ACCESS_REQUEST', ) + ], +attributes={domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250}, +zone='Deployment zone for the Product', +status='active', +status_date_time='2020-05-19T13:49:37.385Z', +reason='Reason', +notes='Example notes', +date_created='2020-05-19T13:49:37.385Z', +last_updated='2020-05-19T13:49:37.385Z', +org_type='test' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompleted.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..4693d1444 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompleted.md @@ -0,0 +1,74 @@ +--- +id: beta-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompleted', 'BetaProvisioningCompleted'] +slug: /tools/sdk/python/beta/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'BetaProvisioningCompleted'] +--- + +# ProvisioningCompleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tracking_number** | **str** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**sources** | **str** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**action** | **str** | Origin of where the provisioning request came from. | [optional] +**errors** | **[]str** | A list of any accumulated error messages that occurred during provisioning. | [optional] +**warnings** | **[]str** | A list of any accumulated warning messages that occurred during provisioning. | [optional] +**recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_completed import ProvisioningCompleted + +provisioning_completed = ProvisioningCompleted( +tracking_number='4b4d982dddff4267ab12f0f1e72b5a6d', +sources='Corp AD, Corp LDAP, Corp Salesforce', +action='IdentityRefresh', +errors=[ + 'Connector AD Failed' + ], +warnings=[ + 'Notification Skipped due to invalid email' + ], +recipient=sailpoint.beta.models.provisioning_completed_recipient.ProvisioningCompleted_recipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +requester=sailpoint.beta.models.provisioning_completed_requester.ProvisioningCompleted_requester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +account_requests=[ + sailpoint.beta.models.provisioning_completed_account_requests_inner.ProvisioningCompleted_accountRequests_inner( + source = sailpoint.beta.models.provisioning_completed_account_requests_inner_source.ProvisioningCompleted_accountRequests_inner_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), + account_id = 'CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com', + account_operation = 'Modify', + provisioning_result = SUCCESS, + provisioning_target = 'Corp AD', + ticket_id = '72619262', + attribute_requests = [ + sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner( + attribute_name = 'memberOf', + attribute_value = 'CN=jedi,DC=starwars,DC=com', + operation = Add, ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..4632718de --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,53 @@ +--- +id: beta-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'BetaProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/python/beta/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'BetaProvisioningCompletedAccountRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required] +**account_id** | **str** | The unique idenfier of the account being provisioned. | [optional] +**account_operation** | **str** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required] +**provisioning_result** | **Enum** [ 'SUCCESS', 'PENDING', 'FAILED' ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required] +**provisioning_target** | **str** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required] +**ticket_id** | **str** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] +**attribute_requests** | [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_completed_account_requests_inner import ProvisioningCompletedAccountRequestsInner + +provisioning_completed_account_requests_inner = ProvisioningCompletedAccountRequestsInner( +source=sailpoint.beta.models.provisioning_completed_account_requests_inner_source.ProvisioningCompleted_accountRequests_inner_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), +account_id='CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com', +account_operation='Modify', +provisioning_result=SUCCESS, +provisioning_target='Corp AD', +ticket_id='72619262', +attribute_requests=[ + sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner( + attribute_name = 'memberOf', + attribute_value = 'CN=jedi,DC=starwars,DC=com', + operation = Add, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..a34e23a74 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,37 @@ +--- +id: beta-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/python/beta/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_name** | **str** | The name of the attribute being provisioned. | [required] +**attribute_value** | **str** | The value of the attribute being provisioned. | [optional] +**operation** | **Enum** [ 'Add', 'Set', 'Remove' ] | The operation to handle the attribute. | [required] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner import ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +provisioning_completed_account_requests_inner_attribute_requests_inner = ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner( +attribute_name='memberOf', +attribute_value='CN=jedi,DC=starwars,DC=com', +operation=Add +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..93c2486a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,38 @@ +--- +id: beta-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'BetaProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/python/beta/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'BetaProvisioningCompletedAccountRequestsInnerSource'] +--- + +# ProvisioningCompletedAccountRequestsInnerSource + +Reference to the source being provisioned against. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the object to which this reference applies | [required] +**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required] +**name** | **str** | Human-readable display name of the object to which this reference applies | [required] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_completed_account_requests_inner_source import ProvisioningCompletedAccountRequestsInnerSource + +provisioning_completed_account_requests_inner_source = ProvisioningCompletedAccountRequestsInnerSource( +id='4e4d982dddff4267ab12f0f1e72b5a6d', +type='SOURCE', +name='Corporate Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..0c8c684e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,38 @@ +--- +id: beta-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedRecipient', 'BetaProvisioningCompletedRecipient'] +slug: /tools/sdk/python/beta/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'BetaProvisioningCompletedRecipient'] +--- + +# ProvisioningCompletedRecipient + +Provisioning recpient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Provisioning recipient DTO type. | [required] +**id** | **str** | Provisioning recipient's identity ID. | [required] +**name** | **str** | Provisioning recipient's display name. | [required] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_completed_recipient import ProvisioningCompletedRecipient + +provisioning_completed_recipient = ProvisioningCompletedRecipient( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..913d71f53 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,38 @@ +--- +id: beta-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedRequester', 'BetaProvisioningCompletedRequester'] +slug: /tools/sdk/python/beta/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'BetaProvisioningCompletedRequester'] +--- + +# ProvisioningCompletedRequester + +Provisioning requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Provisioning requester's DTO type. | [required] +**id** | **str** | Provisioning requester's identity ID. | [required] +**name** | **str** | Provisioning owner's human-readable display name. | [required] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_completed_requester import ProvisioningCompletedRequester + +provisioning_completed_requester = ProvisioningCompletedRequester( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfig.md new file mode 100644 index 000000000..40f384837 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfig.md @@ -0,0 +1,44 @@ +--- +id: beta-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfig', 'BetaProvisioningConfig'] +slug: /tools/sdk/python/beta/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'BetaProvisioningConfig'] +--- + +# ProvisioningConfig + +Specification of a Service Desk integration provisioning configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universal_manager** | **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to False] +**managed_resource_refs** | [**[]ProvisioningConfigManagedResourceRefsInner**](provisioning-config-managed-resource-refs-inner) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**plan_initializer_script** | [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**no_provisioning_requests** | **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to False] +**provisioning_request_expiration** | **int** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_config import ProvisioningConfig + +provisioning_config = ProvisioningConfig( +universal_manager=True, +managed_resource_refs=[{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], +plan_initializer_script=sailpoint.beta.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), +no_provisioning_requests=True, +provisioning_request_expiration=7 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfigManagedResourceRefsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfigManagedResourceRefsInner.md new file mode 100644 index 000000000..ecab8f5f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfigManagedResourceRefsInner.md @@ -0,0 +1,37 @@ +--- +id: beta-provisioning-config-managed-resource-refs-inner +title: ProvisioningConfigManagedResourceRefsInner +pagination_label: ProvisioningConfigManagedResourceRefsInner +sidebar_label: ProvisioningConfigManagedResourceRefsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfigManagedResourceRefsInner', 'BetaProvisioningConfigManagedResourceRefsInner'] +slug: /tools/sdk/python/beta/models/provisioning-config-managed-resource-refs-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigManagedResourceRefsInner', 'BetaProvisioningConfigManagedResourceRefsInner'] +--- + +# ProvisioningConfigManagedResourceRefsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The type of object being referenced | [optional] +**id** | **object** | ID of the source | [optional] +**name** | **object** | Human-readable display name of the source | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_config_managed_resource_refs_inner import ProvisioningConfigManagedResourceRefsInner + +provisioning_config_managed_resource_refs_inner = ProvisioningConfigManagedResourceRefsInner( +type=SOURCE, +id=2c91808568c529c60168cca6f90c1313, +name=My Source +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..9915bc42e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,35 @@ +--- +id: beta-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'BetaProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/python/beta/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'BetaProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +This is a reference to a plan initializer script. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **str** | This is a Rule that allows provisioning instruction changes. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_config_plan_initializer_script import ProvisioningConfigPlanInitializerScript + +provisioning_config_plan_initializer_script = ProvisioningConfigPlanInitializerScript( +source='\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..a106efe63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,45 @@ +--- +id: beta-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel1', 'BetaProvisioningCriteriaLevel1'] +slug: /tools/sdk/python/beta/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_criteria_level1 import ProvisioningCriteriaLevel1 + +provisioning_criteria_level1 = ProvisioningCriteriaLevel1( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.beta.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..643f0537d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,45 @@ +--- +id: beta-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel2', 'BetaProvisioningCriteriaLevel2'] +slug: /tools/sdk/python/beta/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_criteria_level2 import ProvisioningCriteriaLevel2 + +provisioning_criteria_level2 = ProvisioningCriteriaLevel2( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.beta.models.provisioning_criteria_level3.ProvisioningCriteriaLevel3( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..cb802348e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,40 @@ +--- +id: beta-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel3', 'BetaProvisioningCriteriaLevel3'] +slug: /tools/sdk/python/beta/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_criteria_level3 import ProvisioningCriteriaLevel3 + +provisioning_criteria_level3 = ProvisioningCriteriaLevel3( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..157e25264 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: beta-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaOperation', 'BetaProvisioningCriteriaOperation'] +slug: /tools/sdk/python/beta/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'BetaProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +Supported operations on ProvisioningCriteria + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `HAS` (value: `'HAS'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningDetails.md new file mode 100644 index 000000000..6bf6f34f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningDetails.md @@ -0,0 +1,34 @@ +--- +id: beta-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningDetails', 'BetaProvisioningDetails'] +slug: /tools/sdk/python/beta/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'BetaProvisioningDetails'] +--- + +# ProvisioningDetails + +Provides additional details about provisioning for this request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ordered_sub_phase_references** | **str** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_details import ProvisioningDetails + +provisioning_details = ProvisioningDetails( +ordered_sub_phase_references='manualWorkItemDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..49545c7c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningPolicyDto.md @@ -0,0 +1,47 @@ +--- +id: beta-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningPolicyDto', 'BetaProvisioningPolicyDto'] +slug: /tools/sdk/python/beta/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'BetaProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the provisioning policy name | [required] +**description** | **str** | the description of the provisioning policy | [optional] +**usage_type** | [**UsageType**](usage-type) | | [optional] +**fields** | [**[]FieldDetailsDto**](field-details-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto + +provisioning_policy_dto = ProvisioningPolicyDto( +name='example provisioning policy for inactive identities', +description='this provisioning policy creates access based on an identity going inactive', +usage_type='CREATE', +fields=[ + sailpoint.beta.models.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/Beta/Models/ProvisioningState.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningState.md new file mode 100644 index 000000000..b73a72941 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningState.md @@ -0,0 +1,31 @@ +--- +id: beta-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningState', 'BetaProvisioningState'] +slug: /tools/sdk/python/beta/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'BetaProvisioningState'] +--- + +# ProvisioningState + +Provisioning state of an account activity item + +## Enum + +* `PENDING` (value: `'PENDING'`) + +* `FINISHED` (value: `'FINISHED'`) + +* `UNVERIFIABLE` (value: `'UNVERIFIABLE'`) + +* `COMMITED` (value: `'COMMITED'`) + +* `FAILED` (value: `'FAILED'`) + +* `RETRY` (value: `'RETRY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..1535926d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,36 @@ +--- +id: beta-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityAttributeConfig', 'BetaPublicIdentityAttributeConfig'] +slug: /tools/sdk/python/beta/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'BetaPublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +Used to map an attribute key for an Identity to its display name. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | the key of the attribute | [optional] +**name** | **str** | the display name of the attribute | [optional] +} + +## Example + +```python +from sailpoint.beta.models.public_identity_attribute_config import PublicIdentityAttributeConfig + +public_identity_attribute_config = PublicIdentityAttributeConfig( +key='country', +name='Country' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PublicIdentityConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..7cbd7fc7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PublicIdentityConfig.md @@ -0,0 +1,45 @@ +--- +id: beta-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityConfig', 'BetaPublicIdentityConfig'] +slug: /tools/sdk/python/beta/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'BetaPublicIdentityConfig'] +--- + +# PublicIdentityConfig + +Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | | [optional] +**modified_by** | [**IdentityReference**](identity-reference) | | [optional] +**modified** | **datetime** | the date/time of the modification | [optional] +} + +## Example + +```python +from sailpoint.beta.models.public_identity_config import PublicIdentityConfig + +public_identity_config = PublicIdentityConfig( +attributes=[ + sailpoint.beta.models.public_identity_attribute_config.PublicIdentityAttributeConfig( + key = 'country', + name = 'Country', ) + ], +modified_by=sailpoint.beta.models.identity_reference.IdentityReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ), +modified='2018-06-25T20:22:28.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..bdc93df59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutPasswordDictionaryRequest', 'BetaPutPasswordDictionaryRequest'] +slug: /tools/sdk/python/beta/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'BetaPutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.put_password_dictionary_request import PutPasswordDictionaryRequest + +put_password_dictionary_request = PutPasswordDictionaryRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..c9fe48e76 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,36 @@ +--- +id: beta-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueuedCheckConfigDetails', 'BetaQueuedCheckConfigDetails'] +slug: /tools/sdk/python/beta/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'BetaQueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +Configuration of maximum number of days and interval for checking Service Desk integration queue status. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provisioning_status_check_interval_minutes** | **str** | Interval in minutes between status checks | [required] +**provisioning_max_status_check_days** | **str** | Maximum number of days to check | [required] +} + +## Example + +```python +from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails + +queued_check_config_details = QueuedCheckConfigDetails( +provisioning_status_check_interval_minutes='30', +provisioning_max_status_check_days='2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReassignReference.md b/docs/tools/sdk/python/Reference/Beta/Models/ReassignReference.md new file mode 100644 index 000000000..9cac7a68a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReassignReference.md @@ -0,0 +1,35 @@ +--- +id: beta-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignReference', 'BetaReassignReference'] +slug: /tools/sdk/python/beta/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'BetaReassignReference'] +--- + +# ReassignReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of item or identity being reassigned. | [required] +**type** | **Enum** [ 'TARGET_SUMMARY', 'ITEM', 'IDENTITY_SUMMARY' ] | The type of item or identity being reassigned. | [required] +} + +## Example + +```python +from sailpoint.beta.models.reassign_reference import ReassignReference + +reassign_reference = ReassignReference( +id='ef38f94347e94562b5bb8424a56397d8', +type='ITEM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Reassignment.md b/docs/tools/sdk/python/Reference/Beta/Models/Reassignment.md new file mode 100644 index 000000000..6336c0b32 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Reassignment.md @@ -0,0 +1,35 @@ +--- +id: beta-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reassignment', 'BetaReassignment'] +slug: /tools/sdk/python/beta/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'BetaReassignment'] +--- + +# Reassignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_from** | [**CertificationReference**](certification-reference) | | [optional] +**comment** | **str** | Comments from the previous reviewer. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.reassignment import Reassignment + +reassignment = Reassignment( +var_from=sailpoint.beta.models.certification_reference.CertificationReference(), +comment='Please review' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReassignmentType.md b/docs/tools/sdk/python/Reference/Beta/Models/ReassignmentType.md new file mode 100644 index 000000000..274488dd8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReassignmentType.md @@ -0,0 +1,27 @@ +--- +id: beta-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentType', 'BetaReassignmentType'] +slug: /tools/sdk/python/beta/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'BetaReassignmentType'] +--- + +# ReassignmentType + +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). + +## Enum + +* `MANUAL_REASSIGNMENT` (value: `'MANUAL_REASSIGNMENT'`) + +* `AUTOMATIC_REASSIGNMENT` (value: `'AUTOMATIC_REASSIGNMENT'`) + +* `AUTO_ESCALATION` (value: `'AUTO_ESCALATION'`) + +* `SELF_REVIEW_DELEGATION` (value: `'SELF_REVIEW_DELEGATION'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/python/Reference/Beta/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..0e5aaa9c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReassignmentTypeEnum.md @@ -0,0 +1,27 @@ +--- +id: beta-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentTypeEnum', 'BetaReassignmentTypeEnum'] +slug: /tools/sdk/python/beta/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'BetaReassignmentTypeEnum'] +--- + +# ReassignmentTypeEnum + +Enum list containing types of Reassignment that can be found in the evaluate response. + +## Enum + +* `MANUAL_REASSIGNMENT_COMMA` (value: `'MANUAL_REASSIGNMENT,'`) + +* `AUTOMATIC_REASSIGNMENT_COMMA` (value: `'AUTOMATIC_REASSIGNMENT,'`) + +* `AUTO_ESCALATION_COMMA` (value: `'AUTO_ESCALATION,'`) + +* `SELF_REVIEW_DELEGATION` (value: `'SELF_REVIEW_DELEGATION'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Recommendation.md b/docs/tools/sdk/python/Reference/Beta/Models/Recommendation.md new file mode 100644 index 000000000..c6fcbf2d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Recommendation.md @@ -0,0 +1,35 @@ +--- +id: beta-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Recommendation', 'BetaRecommendation'] +slug: /tools/sdk/python/beta/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'BetaRecommendation'] +--- + +# Recommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required] +**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] +} + +## Example + +```python +from sailpoint.beta.models.recommendation import Recommendation + +recommendation = Recommendation( +type='MACHINE', +method='DISCOVERY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommendationConfigDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..9920a0bd4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationConfigDto.md @@ -0,0 +1,39 @@ +--- +id: beta-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationConfigDto', 'BetaRecommendationConfigDto'] +slug: /tools/sdk/python/beta/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'BetaRecommendationConfigDto'] +--- + +# RecommendationConfigDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommender_features** | **[]str** | List of identity attributes to use for calculating certification recommendations | [optional] +**peer_group_percentage_threshold** | **float** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**run_auto_select_once** | **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to False] +**only_tune_threshold** | **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto + +recommendation_config_dto = RecommendationConfigDto( +recommender_features=[jobTitle, location, peer_group, department, active], +peer_group_percentage_threshold=0.5, +run_auto_select_once=False, +only_tune_threshold=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommendationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationRequest.md new file mode 100644 index 000000000..b1ab39e26 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationRequest', 'BetaRecommendationRequest'] +slug: /tools/sdk/python/beta/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'BetaRecommendationRequest'] +--- + +# RecommendationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID | [optional] +**item** | [**AccessItemRef**](access-item-ref) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.recommendation_request import RecommendationRequest + +recommendation_request = RecommendationRequest( +identity_id='2c938083633d259901633d25c68c00fa', +item=sailpoint.beta.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommendationRequestDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..9932be736 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationRequestDto.md @@ -0,0 +1,47 @@ +--- +id: beta-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationRequestDto', 'BetaRecommendationRequestDto'] +slug: /tools/sdk/python/beta/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'BetaRecommendationRequestDto'] +--- + +# RecommendationRequestDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requests** | [**[]RecommendationRequest**](recommendation-request) | | [optional] +**exclude_interpretations** | **bool** | Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. | [optional] [default to False] +**include_translation_messages** | **bool** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to False] +**include_debug_information** | **bool** | Returns the recommender calculations if set to true | [optional] [default to False] +**prescribe_mode** | **bool** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.recommendation_request_dto import RecommendationRequestDto + +recommendation_request_dto = RecommendationRequestDto( +requests=[ + sailpoint.beta.models.recommendation_request.RecommendationRequest( + identity_id = '2c938083633d259901633d25c68c00fa', + item = sailpoint.beta.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ), ) + ], +exclude_interpretations=False, +include_translation_messages=False, +include_debug_information=True, +prescribe_mode=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommendationResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationResponse.md new file mode 100644 index 000000000..f863be37e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationResponse.md @@ -0,0 +1,61 @@ +--- +id: beta-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationResponse', 'BetaRecommendationResponse'] +slug: /tools/sdk/python/beta/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'BetaRecommendationResponse'] +--- + +# RecommendationResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request** | [**RecommendationRequest**](recommendation-request) | | [optional] +**recommendation** | **Enum** [ 'true', 'false', 'MAYBE', 'NOT_FOUND' ] | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**interpretations** | **[]str** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**translation_messages** | [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**recommender_calculations** | [**RecommenderCalculations**](recommender-calculations) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.recommendation_response import RecommendationResponse + +recommendation_response = RecommendationResponse( +request=sailpoint.beta.models.recommendation_request.RecommendationRequest( + identity_id = '2c938083633d259901633d25c68c00fa', + item = sailpoint.beta.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ), ), +recommendation='true', +interpretations=[75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.], +translation_messages=[{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}], +recommender_calculations=sailpoint.beta.models.recommender_calculations.RecommenderCalculations( + identity_id = '2c91808457d8f3ab0157e3e62cb4213c', + entitlement_id = '2c91809050db617d0150e0bf3215385e', + recommendation = 'YES', + overall_weighted_score = 1.337, + feature_weighted_scores = { + 'key' : 1.337 + }, + threshold = 1.337, + identity_attributes = { + 'key' : sailpoint.beta.models.recommender_calculations_identity_attributes_value.RecommenderCalculations_identityAttributes_value( + value = '', ) + }, + feature_values = sailpoint.beta.models.feature_value_dto.FeatureValueDto( + feature = 'department', + numerator = 14, + denominator = 14, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommendationResponseDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..914936acd --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommendationResponseDto.md @@ -0,0 +1,60 @@ +--- +id: beta-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationResponseDto', 'BetaRecommendationResponseDto'] +slug: /tools/sdk/python/beta/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'BetaRecommendationResponseDto'] +--- + +# RecommendationResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**response** | [**[]RecommendationResponse**](recommendation-response) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.recommendation_response_dto import RecommendationResponseDto + +recommendation_response_dto = RecommendationResponseDto( +response=[ + sailpoint.beta.models.recommendation_response.RecommendationResponse( + request = sailpoint.beta.models.recommendation_request.RecommendationRequest( + identity_id = '2c938083633d259901633d25c68c00fa', + item = sailpoint.beta.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ), ), + recommendation = 'true', + interpretations = [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.], + translation_messages = [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}], + recommender_calculations = sailpoint.beta.models.recommender_calculations.RecommenderCalculations( + identity_id = '2c91808457d8f3ab0157e3e62cb4213c', + entitlement_id = '2c91809050db617d0150e0bf3215385e', + recommendation = 'YES', + overall_weighted_score = 1.337, + feature_weighted_scores = { + 'key' : 1.337 + }, + threshold = 1.337, + identity_attributes = { + 'key' : sailpoint.beta.models.recommender_calculations_identity_attributes_value.RecommenderCalculations_identityAttributes_value( + value = '', ) + }, + feature_values = sailpoint.beta.models.feature_value_dto.FeatureValueDto( + feature = 'department', + numerator = 14, + denominator = 14, ), ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommenderCalculations.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommenderCalculations.md new file mode 100644 index 000000000..762b5c257 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommenderCalculations.md @@ -0,0 +1,55 @@ +--- +id: beta-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommenderCalculations', 'BetaRecommenderCalculations'] +slug: /tools/sdk/python/beta/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'BetaRecommenderCalculations'] +--- + +# RecommenderCalculations + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The ID of the identity | [optional] +**entitlement_id** | **str** | The entitlement ID | [optional] +**recommendation** | **str** | The actual recommendation | [optional] +**overall_weighted_score** | **float** | The overall weighted score | [optional] +**feature_weighted_scores** | **map[string]float** | The weighted score of each individual feature | [optional] +**threshold** | **float** | The configured value against which the overallWeightedScore is compared | [optional] +**identity_attributes** | [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**feature_values** | [**FeatureValueDto**](feature-value-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.recommender_calculations import RecommenderCalculations + +recommender_calculations = RecommenderCalculations( +identity_id='2c91808457d8f3ab0157e3e62cb4213c', +entitlement_id='2c91809050db617d0150e0bf3215385e', +recommendation='YES', +overall_weighted_score=1.337, +feature_weighted_scores={ + 'key' : 1.337 + }, +threshold=1.337, +identity_attributes={ + 'key' : sailpoint.beta.models.recommender_calculations_identity_attributes_value.RecommenderCalculations_identityAttributes_value( + value = '', ) + }, +feature_values=sailpoint.beta.models.feature_value_dto.FeatureValueDto( + feature = 'department', + numerator = 14, + denominator = 14, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/python/Reference/Beta/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..d8930dd2a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,33 @@ +--- +id: beta-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'BetaRecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/python/beta/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'BetaRecommenderCalculationsIdentityAttributesValue'] +--- + +# RecommenderCalculationsIdentityAttributesValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.recommender_calculations_identity_attributes_value import RecommenderCalculationsIdentityAttributesValue + +recommender_calculations_identity_attributes_value = RecommenderCalculationsIdentityAttributesValue( +value='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RemediationItemDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/RemediationItemDetails.md new file mode 100644 index 000000000..d1507d8b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RemediationItemDetails.md @@ -0,0 +1,49 @@ +--- +id: beta-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RemediationItemDetails', 'BetaRemediationItemDetails'] +slug: /tools/sdk/python/beta/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'BetaRemediationItemDetails'] +--- + +# RemediationItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification | [optional] +**target_id** | **str** | The ID of the certification target | [optional] +**target_name** | **str** | The name of the certification target | [optional] +**target_display_name** | **str** | The display name of the certification target | [optional] +**application_name** | **str** | The name of the application/source | [optional] +**attribute_name** | **str** | The name of the attribute being certified | [optional] +**attribute_operation** | **str** | The operation of the certification on the attribute | [optional] +**attribute_value** | **str** | The value of the attribute being certified | [optional] +**native_identity** | **str** | The native identity of the target | [optional] +} + +## Example + +```python +from sailpoint.beta.models.remediation_item_details import RemediationItemDetails + +remediation_item_details = RemediationItemDetails( +id='2c9180835d2e5168015d32f890ca1581', +target_id='2c9180835d2e5168015d32f890ca1581', +target_name='john.smith', +target_display_name='emailAddress', +application_name='Active Directory', +attribute_name='phoneNumber', +attribute_operation='update', +attribute_value='512-555-1212', +native_identity='jason.smith2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RemediationItems.md b/docs/tools/sdk/python/Reference/Beta/Models/RemediationItems.md new file mode 100644 index 000000000..e64273be3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RemediationItems.md @@ -0,0 +1,49 @@ +--- +id: beta-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RemediationItems', 'BetaRemediationItems'] +slug: /tools/sdk/python/beta/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'BetaRemediationItems'] +--- + +# RemediationItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification | [optional] +**target_id** | **str** | The ID of the certification target | [optional] +**target_name** | **str** | The name of the certification target | [optional] +**target_display_name** | **str** | The display name of the certification target | [optional] +**application_name** | **str** | The name of the application/source | [optional] +**attribute_name** | **str** | The name of the attribute being certified | [optional] +**attribute_operation** | **str** | The operation of the certification on the attribute | [optional] +**attribute_value** | **str** | The value of the attribute being certified | [optional] +**native_identity** | **str** | The native identity of the target | [optional] +} + +## Example + +```python +from sailpoint.beta.models.remediation_items import RemediationItems + +remediation_items = RemediationItems( +id='2c9180835d2e5168015d32f890ca1581', +target_id='2c9180835d2e5168015d32f890ca1581', +target_name='john.smith', +target_display_name='emailAddress', +application_name='Active Directory', +attribute_name='phoneNumber', +attribute_operation='update', +attribute_value='512-555-1212', +native_identity='jason.smith2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReportConfigDTO.md b/docs/tools/sdk/python/Reference/Beta/Models/ReportConfigDTO.md new file mode 100644 index 000000000..c50daf89a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReportConfigDTO.md @@ -0,0 +1,39 @@ +--- +id: beta-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportConfigDTO', 'BetaReportConfigDTO'] +slug: /tools/sdk/python/beta/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'BetaReportConfigDTO'] +--- + +# ReportConfigDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**column_name** | **str** | Name of column in report | [optional] +**required** | **bool** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to False] +**included** | **bool** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to False] +**order** | **int** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.report_config_dto import ReportConfigDTO + +report_config_dto = ReportConfigDTO( +column_name='SOD Business Name', +required=True, +included=False, +order=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReportResultReference.md b/docs/tools/sdk/python/Reference/Beta/Models/ReportResultReference.md new file mode 100644 index 000000000..45299b886 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReportResultReference.md @@ -0,0 +1,39 @@ +--- +id: beta-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportResultReference', 'BetaReportResultReference'] +slug: /tools/sdk/python/beta/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'BetaReportResultReference'] +--- + +# ReportResultReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +**status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR', 'PENDING' ] | Status of a SOD policy violation report. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.report_result_reference import ReportResultReference + +report_result_reference = ReportResultReference( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation', +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReportType.md b/docs/tools/sdk/python/Reference/Beta/Models/ReportType.md new file mode 100644 index 000000000..041e7eb7e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReportType.md @@ -0,0 +1,27 @@ +--- +id: beta-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportType', 'BetaReportType'] +slug: /tools/sdk/python/beta/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'BetaReportType'] +--- + +# ReportType + +type of a Report + +## Enum + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `'CAMPAIGN_COMPOSITION_REPORT'`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `'CAMPAIGN_REMEDIATION_STATUS_REPORT'`) + +* `CAMPAIGN_STATUS_REPORT` (value: `'CAMPAIGN_STATUS_REPORT'`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `'CERTIFICATION_SIGNOFF_REPORT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..257d26596 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestOnBehalfOfConfig', 'BetaRequestOnBehalfOfConfig'] +slug: /tools/sdk/python/beta/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'BetaRequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allow_request_on_behalf_of_anyone_by_anyone** | **bool** | If this is true, anyone can request access for anyone. | [optional] [default to False] +**allow_request_on_behalf_of_employee_by_manager** | **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.request_on_behalf_of_config import RequestOnBehalfOfConfig + +request_on_behalf_of_config = RequestOnBehalfOfConfig( +allow_request_on_behalf_of_anyone_by_anyone=True, +allow_request_on_behalf_of_employee_by_manager=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md b/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md new file mode 100644 index 000000000..445144075 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md @@ -0,0 +1,41 @@ +--- +id: beta-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Requestability', 'BetaRequestability'] +slug: /tools/sdk/python/beta/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability'] +--- + +# Requestability + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requestability import Requestability + +requestability = Requestability( +comments_required=True, +denial_comments_required=True, +approval_schemes=[ + sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md new file mode 100644 index 000000000..6c3e1c781 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md @@ -0,0 +1,41 @@ +--- +id: beta-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestabilityForRole', 'BetaRequestabilityForRole'] +slug: /tools/sdk/python/beta/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'BetaRequestabilityForRole'] +--- + +# RequestabilityForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requestability_for_role import RequestabilityForRole + +requestability_for_role = RequestabilityForRole( +comments_required=True, +denial_comments_required=True, +approval_schemes=[ + sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestableObject.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObject.md new file mode 100644 index 000000000..9434ff320 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObject.md @@ -0,0 +1,55 @@ +--- +id: beta-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObject', 'BetaRequestableObject'] +slug: /tools/sdk/python/beta/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'BetaRequestableObject'] +--- + +# RequestableObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the requestable object itself | [optional] +**name** | **str** | Human-readable display name of the requestable object | [optional] +**created** | **datetime** | The time when the requestable object was created | [optional] +**modified** | **datetime** | The time when the requestable object was last modified | [optional] +**description** | **str** | Description of the requestable object. | [optional] +**type** | [**RequestableObjectType**](requestable-object-type) | | [optional] +**request_status** | [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**identity_request_id** | **str** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**owner_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**request_comments_required** | **bool** | Whether the requester must provide comments when requesting the object. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requestable_object import RequestableObject + +requestable_object = RequestableObject( +id='2c9180835d2e5168015d32f890ca1581', +name='Applied Research Access', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +description='Access to research information, lab results, and schematics.', +type='ACCESS_PROFILE', +request_status=, +identity_request_id='', +owner_ref=sailpoint.beta.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +request_comments_required=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectReference.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectReference.md new file mode 100644 index 000000000..ba12d627c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectReference.md @@ -0,0 +1,39 @@ +--- +id: beta-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectReference', 'BetaRequestableObjectReference'] +slug: /tools/sdk/python/beta/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'BetaRequestableObjectReference'] +--- + +# RequestableObjectReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the object. | [optional] +**name** | **str** | Name of the object. | [optional] +**description** | **str** | Description of the object. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of the object. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requestable_object_reference import RequestableObjectReference + +requestable_object_reference = RequestableObjectReference( +id='2c938083633d259901633d25c68c00fa', +name='Object Name', +description='Object Description', +type='ROLE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..fe0d747b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,25 @@ +--- +id: beta-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectRequestStatus', 'BetaRequestableObjectRequestStatus'] +slug: /tools/sdk/python/beta/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'BetaRequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. + +## Enum + +* `AVAILABLE` (value: `'AVAILABLE'`) + +* `PENDING` (value: `'PENDING'`) + +* `ASSIGNED` (value: `'ASSIGNED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectType.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectType.md new file mode 100644 index 000000000..ec221957d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestableObjectType.md @@ -0,0 +1,25 @@ +--- +id: beta-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectType', 'BetaRequestableObjectType'] +slug: /tools/sdk/python/beta/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'BetaRequestableObjectType'] +--- + +# RequestableObjectType + +The currently supported requestable object types. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDetails.md new file mode 100644 index 000000000..333c28bdc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDetails.md @@ -0,0 +1,35 @@ +--- +id: beta-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDetails', 'BetaRequestedItemDetails'] +slug: /tools/sdk/python/beta/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'BetaRequestedItemDetails'] +--- + +# RequestedItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ENTITLEMENT', 'ROLE' ] | The type of access item requested. | [optional] +**id** | **str** | The id of the access item requested. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_details import RequestedItemDetails + +requested_item_details = RequestedItemDetails( +type='ENTITLEMENT', +id='779c6fd7171540bba1184e5946112c28' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatus.md new file mode 100644 index 000000000..c6592d74c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatus.md @@ -0,0 +1,144 @@ +--- +id: beta-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'BetaRequestedItemStatus'] +slug: /tools/sdk/python/beta/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedItemStatus'] +--- + +# RequestedItemStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the access request. | [optional] +**name** | **str** | Human-readable display name of the item being requested. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional] +**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional] +**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**account_activity_item_id** | **str** | Id of associated account activity item. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**description** | **str** | Description associated to the requested object. | [optional] +**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional] +**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False] +**access_request_id** | **str** | This is the account activity id. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_status import RequestedItemStatus + +requested_item_status = RequestedItemStatus( +id='2c9180926cbfbddd016cbfc7c3b10010', +name='AccessProfile1', +type='ACCESS_PROFILE', +cancelled_request_details=, +error_messages=[ + [ + sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ] + ], +state='EXECUTING', +approval_details=[ + sailpoint.beta.models.approval_status_dto.ApprovalStatusDto( + approval_id = '2c9180877b2b6ea4017b2c545f971429', + forwarded = False, + original_owner = sailpoint.beta.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = null, + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + scheme = 'MANAGER', + error_messages = [ + sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], + comment = 'I approve this request', + remove_date = '2020-07-11T00:00Z', ) + ], +approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5], +manual_work_item_details=[ + sailpoint.beta.models.manual_work_item_details.ManualWorkItemDetails( + forwarded = True, + original_owner = sailpoint.beta.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = sailpoint.beta.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + forward_history = [ + sailpoint.beta.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], ) + ], +account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010', +request_type='GRANT_ACCESS', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +requester=sailpoint.beta.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.beta.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +requester_comment=, +sod_violation_context=, +provisioning_details=, +pre_approval_trigger_details=, +access_request_phases=[ + sailpoint.beta.models.access_request_phases.AccessRequestPhases( + started = '2020-07-11T00:00Z', + finished = '2020-07-12T00:00Z', + name = 'APPROVAL_PHASE', + state = 'COMPLETED', + result = 'SUCCESSFUL', + phase_reference = 'approvalDetails', ) + ], +description='This is the Engineering role that engineers are granted.', +remove_date='2019-10-23T00:00Z', +cancelable=True, +access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +client_metadata={key1=value1, key2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..cc5757ac2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,40 @@ +--- +id: beta-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'BetaRequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/python/beta/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'BetaRequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_status_cancelled_request_details import RequestedItemStatusCancelledRequestDetails + +requested_item_status_cancelled_request_details = RequestedItemStatusCancelledRequestDetails( +comment='This request must be cancelled.', +owner=sailpoint.beta.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +modified='2019-12-20T09:17:12.192Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..9c7075cd2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'BetaRequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/python/beta/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'BetaRequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment left for the pre-approval decision | [optional] +**reviewer** | **str** | The reviewer of the pre-approval decision | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | The decision of the pre-approval trigger | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_status_pre_approval_trigger_details import RequestedItemStatusPreApprovalTriggerDetails + +requested_item_status_pre_approval_trigger_details = RequestedItemStatusPreApprovalTriggerDetails( +comment='Access is Approved', +reviewer='John Doe', +decision='APPROVED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..4f83d4acc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,33 @@ +--- +id: beta-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusProvisioningDetails', 'BetaRequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/python/beta/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'BetaRequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ordered_sub_phase_references** | **str** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_status_provisioning_details import RequestedItemStatusProvisioningDetails + +requested_item_status_provisioning_details = RequestedItemStatusProvisioningDetails( +ordered_sub_phase_references='manualWorkItemDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..c258208fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,37 @@ +--- +id: beta-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequestState', 'BetaRequestedItemStatusRequestState'] +slug: /tools/sdk/python/beta/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'BetaRequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. + +## Enum + +* `EXECUTING` (value: `'EXECUTING'`) + +* `REQUEST_COMPLETED` (value: `'REQUEST_COMPLETED'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +* `TERMINATED` (value: `'TERMINATED'`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `'PROVISIONING_VERIFICATION_PENDING'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `PROVISIONING_FAILED` (value: `'PROVISIONING_FAILED'`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `'NOT_ALL_ITEMS_PROVISIONED'`) + +* `ERROR` (value: `'ERROR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..fe6e3d4a1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,38 @@ +--- +id: beta-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequestedFor', 'BetaRequestedItemStatusRequestedFor'] +slug: /tools/sdk/python/beta/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'BetaRequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +Identity access was requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | 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.beta.models.requested_item_status_requested_for import RequestedItemStatusRequestedFor + +requested_item_status_requested_for = RequestedItemStatusRequestedFor( +type='IDENTITY', +id='2c9180835d191a86015d28455b4b232a', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..8084ee363 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,40 @@ +--- +id: beta-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequesterComment', 'BetaRequestedItemStatusRequesterComment'] +slug: /tools/sdk/python/beta/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'BetaRequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDto1Author**](comment-dto1-author) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_status_requester_comment import RequestedItemStatusRequesterComment + +requested_item_status_requester_comment = RequestedItemStatusRequesterComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.beta.models.comment_dto_1_author.CommentDto_1_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..ee38d5025 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,64 @@ +--- +id: beta-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusSodViolationContext', 'BetaRequestedItemStatusSodViolationContext'] +slug: /tools/sdk/python/beta/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'BetaRequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_status_sod_violation_context import RequestedItemStatusSodViolationContext + +requested_item_status_sod_violation_context = RequestedItemStatusSodViolationContext( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.beta.models.sod_violation_check_result.SodViolationCheckResult( + message = sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.beta.models.sod_violation_context.SodViolationContext( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ResourceBundleMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/ResourceBundleMessage.md new file mode 100644 index 000000000..6bbcc22b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ResourceBundleMessage.md @@ -0,0 +1,35 @@ +--- +id: beta-resource-bundle-message +title: ResourceBundleMessage +pagination_label: ResourceBundleMessage +sidebar_label: ResourceBundleMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceBundleMessage', 'BetaResourceBundleMessage'] +slug: /tools/sdk/python/beta/models/resource-bundle-message +tags: ['SDK', 'Software Development Kit', 'ResourceBundleMessage', 'BetaResourceBundleMessage'] +--- + +# ResourceBundleMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the message | [optional] +**format** | **str** | The format of the message | [optional] +} + +## Example + +```python +from sailpoint.beta.models.resource_bundle_message import ResourceBundleMessage + +resource_bundle_message = ResourceBundleMessage( +key='recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_LOW', +format='{0,,\"i18n hint: percentage\"}% of identities with the same {1,,\"i18n hint: name of category feature\"} have this access. This information had a low impact on the overall score.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ResourceObject.md b/docs/tools/sdk/python/Reference/Beta/Models/ResourceObject.md new file mode 100644 index 000000000..c6ea56c9f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ResourceObject.md @@ -0,0 +1,58 @@ +--- +id: beta-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceObject', 'BetaResourceObject'] +slug: /tools/sdk/python/beta/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'BetaResourceObject'] +--- + +# ResourceObject + +Representation of the object which is returned from source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instance** | **str** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**identity** | **str** | Native identity of the object in the Source. | [optional] [readonly] +**uuid** | **str** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**previous_identity** | **str** | Native identity that the object has previously. | [optional] [readonly] +**name** | **str** | Display name for this object. | [optional] [readonly] +**object_type** | **str** | Type of object. | [optional] [readonly] +**incomplete** | **bool** | 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. | [optional] [readonly] +**incremental** | **bool** | 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. | [optional] [readonly] +**delete** | **bool** | 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. | [optional] [readonly] +**remove** | **bool** | 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. | [optional] [readonly] +**missing** | **[]str** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [optional] [readonly] +**attributes** | **object** | Attributes of this ResourceObject. | [optional] [readonly] +**final_update** | **bool** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.resource_object import ResourceObject + +resource_object = ResourceObject( +instance='', +identity='CN=Aaron Carr,OU=test1,DC=test2,DC=test', +uuid='{abf7bd9b-68b4-4d21-9b70-870c58ebf844}', +previous_identity='', +name='Aaron Carr', +object_type='account', +incomplete=False, +incremental=False, +delete=False, +remove=False, +missing=[missFieldOne, missFieldTwo], +attributes={telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr}, +final_update=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ResourceObjectsRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..29104eced --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ResourceObjectsRequest.md @@ -0,0 +1,36 @@ +--- +id: beta-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceObjectsRequest', 'BetaResourceObjectsRequest'] +slug: /tools/sdk/python/beta/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'BetaResourceObjectsRequest'] +--- + +# ResourceObjectsRequest + +Request model for peek resource objects from source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_type** | **str** | The type of resource objects to iterate over. | [optional] [default to 'account'] +**max_count** | **int** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] +} + +## Example + +```python +from sailpoint.beta.models.resource_objects_request import ResourceObjectsRequest + +resource_objects_request = ResourceObjectsRequest( +object_type='account', +max_count=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ResourceObjectsResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..e17a3e9a1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ResourceObjectsResponse.md @@ -0,0 +1,57 @@ +--- +id: beta-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceObjectsResponse', 'BetaResourceObjectsResponse'] +slug: /tools/sdk/python/beta/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'BetaResourceObjectsResponse'] +--- + +# ResourceObjectsResponse + +Response model for peek resource objects from source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the source | [optional] [readonly] +**name** | **str** | Name of the source | [optional] [readonly] +**object_count** | **int** | The number of objects that were fetched by the connector. | [optional] [readonly] +**elapsed_millis** | **int** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**resource_objects** | [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.resource_objects_response import ResourceObjectsResponse + +resource_objects_response = ResourceObjectsResponse( +id='2c91808568c529c60168cca6f90c1313', +name='ODS-AD-Test [source-999999]', +object_count=25, +elapsed_millis=1055, +resource_objects=[ + sailpoint.beta.models.resource_object.Resource Object( + instance = '', + identity = 'CN=Aaron Carr,OU=test1,DC=test2,DC=test', + uuid = '{abf7bd9b-68b4-4d21-9b70-870c58ebf844}', + previous_identity = '', + name = 'Aaron Carr', + object_type = 'account', + incomplete = False, + incremental = False, + delete = False, + remove = False, + missing = [missFieldOne, missFieldTwo], + attributes = {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr}, + final_update = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ReviewReassign.md b/docs/tools/sdk/python/Reference/Beta/Models/ReviewReassign.md new file mode 100644 index 000000000..ddafcfc78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ReviewReassign.md @@ -0,0 +1,41 @@ +--- +id: beta-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewReassign', 'BetaReviewReassign'] +slug: /tools/sdk/python/beta/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'BetaReviewReassign'] +--- + +# ReviewReassign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign** | [**[]ReassignReference**](reassign-reference) | | [required] +**reassign_to** | **str** | The ID of the identity to which the certification is reassigned | [required] +**reason** | **str** | The reason comment for why the reassign was made | [required] +} + +## Example + +```python +from sailpoint.beta.models.review_reassign import ReviewReassign + +review_reassign = ReviewReassign( +reassign=[ + sailpoint.beta.models.reassign_reference.ReassignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'ITEM', ) + ], +reassign_to='ef38f94347e94562b5bb8424a56397d8', +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Reviewer.md b/docs/tools/sdk/python/Reference/Beta/Models/Reviewer.md new file mode 100644 index 000000000..aae265d3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Reviewer.md @@ -0,0 +1,40 @@ +--- +id: beta-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reviewer', 'BetaReviewer'] +slug: /tools/sdk/python/beta/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'BetaReviewer'] +--- + +# Reviewer + +Details of the reviewer for certification. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The reviewer's DTO type. | [required] +**id** | **str** | The reviewer's ID. | [required] +**name** | **str** | The reviewer's display name. | [required] +**email** | **str** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.reviewer import Reviewer + +reviewer = Reviewer( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels', +email='reviewer@test.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md b/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md new file mode 100644 index 000000000..fa768f1b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md @@ -0,0 +1,37 @@ +--- +id: beta-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Revocability', 'BetaRevocability'] +slug: /tools/sdk/python/beta/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] +--- + +# Revocability + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.revocability import Revocability + +revocability = Revocability( +approval_schemes=[ + sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RevocabilityForRole.md b/docs/tools/sdk/python/Reference/Beta/Models/RevocabilityForRole.md new file mode 100644 index 000000000..5475c06c0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RevocabilityForRole.md @@ -0,0 +1,41 @@ +--- +id: beta-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RevocabilityForRole', 'BetaRevocabilityForRole'] +slug: /tools/sdk/python/beta/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'BetaRevocabilityForRole'] +--- + +# RevocabilityForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.revocability_for_role import RevocabilityForRole + +revocability_for_role = RevocabilityForRole( +comments_required=False, +denial_comments_required=False, +approval_schemes=[ + sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Role.md b/docs/tools/sdk/python/Reference/Beta/Models/Role.md new file mode 100644 index 000000000..cc5132cea --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Role.md @@ -0,0 +1,119 @@ +--- +id: beta-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Role', 'BetaRole'] +slug: /tools/sdk/python/beta/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'BetaRole'] +--- + +# Role + +A Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**name** | **str** | The human-readable display name of the Role | [required] +**created** | **datetime** | Date the Role was created | [optional] [readonly] +**modified** | **datetime** | Date the Role was last modified. | [optional] [readonly] +**description** | **str** | A human-readable description of the Role | [optional] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**access_profiles** | [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | | [optional] +**membership** | [**RoleMembershipSelector**](role-membership-selector) | | [optional] +**legacy_membership_info** | **map[string]object** | 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. | [optional] +**enabled** | **bool** | Whether the Role is enabled or not. | [optional] [default to False] +**requestable** | **bool** | Whether the Role can be the target of access requests. | [optional] [default to False] +**access_request_config** | [**RequestabilityForRole**](requestability-for-role) | | [optional] +**revocation_request_config** | [**RevocabilityForRole**](revocability-for-role) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**dimensional** | **bool** | Whether the Role is dimensional. | [optional] [default to False] +**dimension_refs** | [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**access_model_metadata** | [**AttributeDTOList**](attribute-dto-list) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role import Role + +role = Role( +id='2c918086749d78830174a1a40e121518', +name='Role 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.beta.models.owner_reference.OwnerReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +access_profiles=[ + sailpoint.beta.models.access_profile_ref.AccessProfileRef( + id = 'ff808081751e6e129f1518161919ecca', + type = 'ACCESS_PROFILE', + name = 'Access Profile 2567', ) + ], +entitlements=[ + sailpoint.beta.models.entitlement_ref.EntitlementRef( + type = 'ENTITLEMENT', + id = '2c91809773dee32014e13e122092014e', + name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', ) + ], +membership=sailpoint.beta.models.role_membership_selector.RoleMembershipSelector( + type = 'IDENTITY_LIST', + criteria = sailpoint.beta.models.role_criteria_level1.RoleCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.beta.models.role_criteria_level2.RoleCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), + identities = [ + sailpoint.beta.models.role_membership_identity.RoleMembershipIdentity( + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', + alias_name = 't.edison', ) + ], ), +legacy_membership_info={type=IDENTITY_LIST}, +enabled=True, +requestable=True, +access_request_config=sailpoint.beta.models.requestability_for_role.RequestabilityForRole( + comments_required = True, + denial_comments_required = True, + approval_schemes = [ + sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +revocation_request_config=sailpoint.beta.models.revocability_for_role.RevocabilityForRole( + comments_required = False, + denial_comments_required = False, + approval_schemes = [ + sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +dimensional=True, +dimension_refs=[ + sailpoint.beta.models.dimension_ref.DimensionRef( + type = 'DIMENSION', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Role 2', ) + ], +access_model_metadata=sailpoint.beta.models.attribute_dto_list.AttributeDTOList( + 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}]}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..7db1fbadf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentDto.md @@ -0,0 +1,82 @@ +--- +id: beta-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentDto', 'BetaRoleAssignmentDto'] +slug: /tools/sdk/python/beta/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'BetaRoleAssignmentDto'] +--- + +# RoleAssignmentDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Assignment Id | [optional] +**role** | [**BaseReferenceDto1**](base-reference-dto1) | | [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** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**assigned_dimensions** | [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**assignment_context** | [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**account_targets** | [**[]RoleTargetDto**](role-target-dto) | | [optional] +**remove_date** | **str** | Date that the assignment will be removed | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_assignment_dto import RoleAssignmentDto + +role_assignment_dto = RoleAssignmentDto( +id='1cbb0705b38c4226b1334eadd8874086', +role=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), +comments='I'm a new Engineer and need this role to do my work', +assignment_source='UI', +assigner=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), +assigned_dimensions=[{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}], +assignment_context=sailpoint.beta.models.assignment_context_dto.AssignmentContextDto( + requested = sailpoint.beta.models.access_request_context.AccessRequestContext( + context_attributes = [ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ), + matched = [ + sailpoint.beta.models.role_match_dto.RoleMatchDto( + role_ref = sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), + matched_attributes = [ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + derived = False, ) + ], ) + ], + computed_date = 'Wed Feb 14 10:58:42', ), +account_targets=[ + sailpoint.beta.models.role_target_dto.RoleTargetDto( + source = sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), + account_info = sailpoint.beta.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/Beta/Models/RoleAssignmentRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..e729601ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentRef.md @@ -0,0 +1,37 @@ +--- +id: beta-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentRef', 'BetaRoleAssignmentRef'] +slug: /tools/sdk/python/beta/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'BetaRoleAssignmentRef'] +--- + +# RoleAssignmentRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Assignment Id | [optional] +**role** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_assignment_ref import RoleAssignmentRef + +role_assignment_ref = RoleAssignmentRef( +id='1cbb0705b38c4226b1334eadd8874086', +role=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..e5e18d9a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleAssignmentSourceType.md @@ -0,0 +1,23 @@ +--- +id: beta-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentSourceType', 'BetaRoleAssignmentSourceType'] +slug: /tools/sdk/python/beta/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'BetaRoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +Type which indicates how a particular Identity obtained a particular Role + +## Enum + +* `ACCESS_REQUEST` (value: `'ACCESS_REQUEST'`) + +* `ROLE_MEMBERSHIP` (value: `'ROLE_MEMBERSHIP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..dca83b474 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleBulkDeleteRequest', 'BetaRoleBulkDeleteRequest'] +slug: /tools/sdk/python/beta/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'BetaRoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_ids** | **[]str** | List of IDs of Roles to be deleted. | [required] +} + +## Example + +```python +from sailpoint.beta.models.role_bulk_delete_request import RoleBulkDeleteRequest + +role_bulk_delete_request = RoleBulkDeleteRequest( +role_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaKey.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..e0e463e12 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaKey.md @@ -0,0 +1,38 @@ +--- +id: beta-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaKey', 'BetaRoleCriteriaKey'] +slug: /tools/sdk/python/beta/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'BetaRoleCriteriaKey'] +--- + +# RoleCriteriaKey + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] +**var_property** | **str** | The name of the attribute or entitlement to which the associated criteria applies. | [required] +**source_id** | **str** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_criteria_key import RoleCriteriaKey + +role_criteria_key = RoleCriteriaKey( +type='ACCOUNT', +var_property='attribute.email', +source_id='2c9180867427f3a301745aec18211519' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..f7bc68595 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaKeyType.md @@ -0,0 +1,25 @@ +--- +id: beta-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaKeyType', 'BetaRoleCriteriaKeyType'] +slug: /tools/sdk/python/beta/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'BetaRoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. + +## Enum + +* `IDENTITY` (value: `'IDENTITY'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..b02935671 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel1.md @@ -0,0 +1,51 @@ +--- +id: beta-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel1', 'BetaRoleCriteriaLevel1'] +slug: /tools/sdk/python/beta/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'BetaRoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +**children** | [**[]RoleCriteriaLevel2**](role-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.beta.models.role_criteria_level1 import RoleCriteriaLevel1 + +role_criteria_level1 = RoleCriteriaLevel1( +operation='EQUALS', +key=sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.beta.models.role_criteria_level2.RoleCriteriaLevel2( + operation = 'EQUALS', + key = sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..e33c210dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel2.md @@ -0,0 +1,51 @@ +--- +id: beta-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel2', 'BetaRoleCriteriaLevel2'] +slug: /tools/sdk/python/beta/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'BetaRoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +**children** | [**[]RoleCriteriaLevel3**](role-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.beta.models.role_criteria_level2 import RoleCriteriaLevel2 + +role_criteria_level2 = RoleCriteriaLevel2( +operation='EQUALS', +key=sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.beta.models.role_criteria_level3.RoleCriteriaLevel3( + operation = 'EQUALS', + key = sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..b49663801 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaLevel3.md @@ -0,0 +1,41 @@ +--- +id: beta-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel3', 'BetaRoleCriteriaLevel3'] +slug: /tools/sdk/python/beta/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'BetaRoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_criteria_level3 import RoleCriteriaLevel3 + +role_criteria_level3 = RoleCriteriaLevel3( +operation='EQUALS', +key=sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaOperation.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..18dfc888c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleCriteriaOperation.md @@ -0,0 +1,33 @@ +--- +id: beta-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaOperation', 'BetaRoleCriteriaOperation'] +slug: /tools/sdk/python/beta/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'BetaRoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +An operation + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `STARTS_WITH` (value: `'STARTS_WITH'`) + +* `ENDS_WITH` (value: `'ENDS_WITH'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleIdentity.md new file mode 100644 index 000000000..af5dcfba0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleIdentity.md @@ -0,0 +1,42 @@ +--- +id: beta-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleIdentity', 'BetaRoleIdentity'] +slug: /tools/sdk/python/beta/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'BetaRoleIdentity'] +--- + +# RoleIdentity + +A subset of the fields of an Identity which is a member of a Role. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Identity | [optional] +**alias_name** | **str** | The alias / username of the Identity | [optional] +**name** | **str** | The human-readable display name of the Identity | [optional] +**email** | **str** | Email address of the Identity | [optional] +**role_assignment_source** | [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_identity import RoleIdentity + +role_identity = RoleIdentity( +id='2c9180a46faadee4016fb4e018c20639', +alias_name='t.edison', +name='Thomas Edison', +email='t.edison@identitynow.com', +role_assignment_source='ACCESS_REQUEST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsight.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsight.md new file mode 100644 index 000000000..c12dbbf44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsight.md @@ -0,0 +1,53 @@ +--- +id: beta-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsight', 'BetaRoleInsight'] +slug: /tools/sdk/python/beta/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'BetaRoleInsight'] +--- + +# RoleInsight + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Insight id | [optional] +**number_of_updates** | **int** | Total number of updates for this role | [optional] +**created_date** | **datetime** | The date-time insights were last created for this role. | [optional] +**modified_date** | **datetime** | The date-time insights were last modified for this role. | [optional] +**role** | [**RoleInsightsRole**](role-insights-role) | | [optional] +**insight** | [**RoleInsightsInsight**](role-insights-insight) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insight import RoleInsight + +role_insight = RoleInsight( +id='1467e61e-f284-439c-ba2d-c6cc11cf0941', +number_of_updates=5, +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date='2020-05-19T13:49:37.385Z', +role=sailpoint.beta.models.role_insights_role.RoleInsightsRole( + name = 'Software Engineer', + id = '1467e61e-f284-439c-ba2d-c6cc11cf0941', + description = 'Person who develops software', + owner_name = 'Bob', + owner_id = '1467e61e-f284-439c-ba2d-c6cc11cf0941', ), +insight=sailpoint.beta.models.role_insights_insight.RoleInsightsInsight( + type = 'ADD', + identities_with_access = 850, + identities_impacted = 150, + total_number_of_identities = 1000, + impacted_identity_names = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..3fb28e4e2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsEntitlement.md @@ -0,0 +1,43 @@ +--- +id: beta-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsEntitlement', 'BetaRoleInsightsEntitlement'] +slug: /tools/sdk/python/beta/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'BetaRoleInsightsEntitlement'] +--- + +# RoleInsightsEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the entitlement | [optional] +**id** | **str** | Id of the entitlement | [optional] +**description** | **str** | Description for the entitlement | [optional] +**source** | **str** | Source or the application for the entitlement | [optional] +**attribute** | **str** | Attribute for the entitlement | [optional] +**value** | **str** | Attribute value for the entitlement | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_entitlement import RoleInsightsEntitlement + +role_insights_entitlement = RoleInsightsEntitlement( +name='', +id='', +description='', +source='', +attribute='', +value='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..0052acead --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,50 @@ +--- +id: beta-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsEntitlementChanges', 'BetaRoleInsightsEntitlementChanges'] +slug: /tools/sdk/python/beta/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'BetaRoleInsightsEntitlementChanges'] +--- + +# RoleInsightsEntitlementChanges + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the entitlement | [optional] +**id** | **str** | Id of the entitlement | [optional] +**description** | **str** | Description for the entitlement | [optional] +**attribute** | **str** | Attribute for the entitlement | [optional] +**value** | **str** | Attribute value for the entitlement | [optional] +**source** | **str** | Source or the application for the entitlement | [optional] +**insight** | [**RoleInsightsInsight**](role-insights-insight) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges + +role_insights_entitlement_changes = RoleInsightsEntitlementChanges( +name='', +id='', +description='', +attribute='', +value='', +source='', +insight=sailpoint.beta.models.role_insights_insight.RoleInsightsInsight( + type = 'ADD', + identities_with_access = 850, + identities_impacted = 150, + total_number_of_identities = 1000, + impacted_identity_names = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsIdentities.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..dda7681e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsIdentities.md @@ -0,0 +1,39 @@ +--- +id: beta-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsIdentities', 'BetaRoleInsightsIdentities'] +slug: /tools/sdk/python/beta/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'BetaRoleInsightsIdentities'] +--- + +# RoleInsightsIdentities + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id for identity | [optional] +**name** | **str** | Name for identity | [optional] +**attributes** | **map[string]str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_identities import RoleInsightsIdentities + +role_insights_identities = RoleInsightsIdentities( +id='', +name='', +attributes={ + 'key' : '' + } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsInsight.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..7ea744a83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsInsight.md @@ -0,0 +1,41 @@ +--- +id: beta-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsInsight', 'BetaRoleInsightsInsight'] +slug: /tools/sdk/python/beta/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'BetaRoleInsightsInsight'] +--- + +# RoleInsightsInsight + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The number of identities in this role with the entitlement. | [optional] +**identities_with_access** | **int** | The number of identities in this role with the entitlement. | [optional] +**identities_impacted** | **int** | The number of identities in this role that do not have the specified entitlement. | [optional] +**total_number_of_identities** | **int** | The total number of identities. | [optional] +**impacted_identity_names** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_insight import RoleInsightsInsight + +role_insights_insight = RoleInsightsInsight( +type='ADD', +identities_with_access=850, +identities_impacted=150, +total_number_of_identities=1000, +impacted_identity_names='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..807390329 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsResponse.md @@ -0,0 +1,45 @@ +--- +id: beta-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsResponse', 'BetaRoleInsightsResponse'] +slug: /tools/sdk/python/beta/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'BetaRoleInsightsResponse'] +--- + +# RoleInsightsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Request Id for a role insight generation request | [optional] +**created_date** | **datetime** | The date-time role insights request was created. | [optional] +**last_generated** | **datetime** | The date-time role insights request was completed. | [optional] +**number_of_updates** | **int** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**role_ids** | **[]str** | The role IDs that are in this request. | [optional] +**status** | **Enum** [ 'CREATED', 'IN PROGRESS', 'COMPLETED', 'FAILED' ] | Request status | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_response import RoleInsightsResponse + +role_insights_response = RoleInsightsResponse( +id='8c190e67-87aa-4ed9-a90b-d9d5344523fb', +created_date='2020-09-16T18:49:32.150Z', +last_generated='2020-09-16T18:50:12.150Z', +number_of_updates=0, +role_ids=[ + '' + ], +status='CREATED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsRole.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsRole.md new file mode 100644 index 000000000..684d16519 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsRole.md @@ -0,0 +1,41 @@ +--- +id: beta-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsRole', 'BetaRoleInsightsRole'] +slug: /tools/sdk/python/beta/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'BetaRoleInsightsRole'] +--- + +# RoleInsightsRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Role name | [optional] +**id** | **str** | Role id | [optional] +**description** | **str** | Role description | [optional] +**owner_name** | **str** | Role owner name | [optional] +**owner_id** | **str** | Role owner id | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_role import RoleInsightsRole + +role_insights_role = RoleInsightsRole( +name='Software Engineer', +id='1467e61e-f284-439c-ba2d-c6cc11cf0941', +description='Person who develops software', +owner_name='Bob', +owner_id='1467e61e-f284-439c-ba2d-c6cc11cf0941' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..252f8d288 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleInsightsSummary.md @@ -0,0 +1,43 @@ +--- +id: beta-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsSummary', 'BetaRoleInsightsSummary'] +slug: /tools/sdk/python/beta/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'BetaRoleInsightsSummary'] +--- + +# RoleInsightsSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_updates** | **int** | Total number of roles with updates | [optional] +**last_generated** | **datetime** | The date-time role insights were last found. | [optional] +**entitlements_included_in_roles** | **int** | The number of entitlements included in roles (vs free radicals). | [optional] +**total_number_of_entitlements** | **int** | The total number of entitlements. | [optional] +**identities_with_access_via_roles** | **int** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**total_number_of_identities** | **int** | The total number of identities. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_insights_summary import RoleInsightsSummary + +role_insights_summary = RoleInsightsSummary( +number_of_updates=56, +last_generated='2020-05-19T13:49:37.385Z', +entitlements_included_in_roles=45, +total_number_of_entitlements=250, +identities_with_access_via_roles=550, +total_number_of_identities=980 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMatchDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMatchDto.md new file mode 100644 index 000000000..5aea822e9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMatchDto.md @@ -0,0 +1,42 @@ +--- +id: beta-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMatchDto', 'BetaRoleMatchDto'] +slug: /tools/sdk/python/beta/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'BetaRoleMatchDto'] +--- + +# RoleMatchDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_ref** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**matched_attributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_match_dto import RoleMatchDto + +role_match_dto = RoleMatchDto( +role_ref=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), +matched_attributes=[ + sailpoint.beta.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..67ee884d2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipIdentity.md @@ -0,0 +1,40 @@ +--- +id: beta-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipIdentity', 'BetaRoleMembershipIdentity'] +slug: /tools/sdk/python/beta/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'BetaRoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +A reference to an Identity in an IDENTITY_LIST role membership criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of the Identity. | [optional] +**alias_name** | **str** | User name of the Identity | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_membership_identity import RoleMembershipIdentity + +role_membership_identity = RoleMembershipIdentity( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison', +alias_name='t.edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipSelector.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..87dafcb87 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipSelector.md @@ -0,0 +1,54 @@ +--- +id: beta-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipSelector', 'BetaRoleMembershipSelector'] +slug: /tools/sdk/python/beta/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'BetaRoleMembershipSelector'] +--- + +# RoleMembershipSelector + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**criteria** | [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**identities** | [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_membership_selector import RoleMembershipSelector + +role_membership_selector = RoleMembershipSelector( +type='IDENTITY_LIST', +criteria=sailpoint.beta.models.role_criteria_level1.RoleCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.beta.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.beta.models.role_criteria_level2.RoleCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), +identities=[ + sailpoint.beta.models.role_membership_identity.RoleMembershipIdentity( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', + alias_name = 't.edison', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..a9da9264d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMembershipSelectorType.md @@ -0,0 +1,23 @@ +--- +id: beta-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipSelectorType', 'BetaRoleMembershipSelectorType'] +slug: /tools/sdk/python/beta/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'BetaRoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +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 + +## Enum + +* `STANDARD` (value: `'STANDARD'`) + +* `IDENTITY_LIST` (value: `'IDENTITY_LIST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningEntitlement.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..2a0190e2a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningEntitlement.md @@ -0,0 +1,53 @@ +--- +id: beta-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningEntitlement', 'BetaRoleMiningEntitlement'] +slug: /tools/sdk/python/beta/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'BetaRoleMiningEntitlement'] +--- + +# RoleMiningEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlement_ref** | [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**name** | **str** | Name of the entitlement | [optional] +**application_name** | **str** | Application name of the entitlement | [optional] +**identity_count** | **int** | The number of identities with this entitlement in a role. | [optional] +**popularity** | **float** | The % popularity of this entitlement in a role. | [optional] +**popularity_in_org** | **float** | The % popularity of this entitlement in the org. | [optional] +**source_id** | **str** | The ID of the source/application. | [optional] +**activity_source_state** | **str** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**source_usage_percent** | **float** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement + +role_mining_entitlement = RoleMiningEntitlement( +entitlement_ref=sailpoint.beta.models.role_mining_entitlement_ref.RoleMiningEntitlementRef( + id = '2c91808a7e95e6e0017e96e2086206c8', + name = 'App.entitlement.1', + description = 'Entitlement 1', + attribute = 'groups', ), +name='Add/modify/delete users', +application_name='AppName', +identity_count=45, +popularity=65.2, +popularity_in_org=35.8, +source_id='2c9180877620c1460176267f336a106f', +activity_source_state='complete', +source_usage_percent=65.6 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..f4c9c9d47 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,39 @@ +--- +id: beta-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningEntitlementRef', 'BetaRoleMiningEntitlementRef'] +slug: /tools/sdk/python/beta/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'BetaRoleMiningEntitlementRef'] +--- + +# RoleMiningEntitlementRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the entitlement | [optional] +**name** | **str** | Name of the entitlement | [optional] +**description** | **str** | Description forthe entitlement | [optional] +**attribute** | **str** | The entitlement attribute | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_entitlement_ref import RoleMiningEntitlementRef + +role_mining_entitlement_ref = RoleMiningEntitlementRef( +id='2c91808a7e95e6e0017e96e2086206c8', +name='App.entitlement.1', +description='Entitlement 1', +attribute='groups' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..ee1676e68 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningIdentity', 'BetaRoleMiningIdentity'] +slug: /tools/sdk/python/beta/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'BetaRoleMiningIdentity'] +--- + +# RoleMiningIdentity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the identity | [optional] +**name** | **str** | Name of the identity | [optional] +**attributes** | **map[string]str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_identity import RoleMiningIdentity + +role_mining_identity = RoleMiningIdentity( +id='', +name='', +attributes={ + 'key' : '' + } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..2368f8c1a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,35 @@ +--- +id: beta-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningIdentityDistribution', 'BetaRoleMiningIdentityDistribution'] +slug: /tools/sdk/python/beta/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'BetaRoleMiningIdentityDistribution'] +--- + +# RoleMiningIdentityDistribution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_name** | **str** | Id of the potential role | [optional] +**distribution** | **[]Dict[str, str]** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_identity_distribution import RoleMiningIdentityDistribution + +role_mining_identity_distribution = RoleMiningIdentityDistribution( +attribute_name='department', +distribution=[{attributeValue=NM Tier 3, count=6}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..d99d81b2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRole.md @@ -0,0 +1,85 @@ +--- +id: beta-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRole', 'BetaRoleMiningPotentialRole'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'BetaRoleMiningPotentialRole'] +--- + +# RoleMiningPotentialRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_by** | [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**density** | **int** | The density of a potential role. | [optional] +**description** | **str** | The description of a potential role. | [optional] +**entitlement_count** | **int** | The number of entitlements in a potential role. | [optional] +**excluded_entitlements** | **[]str** | The list of entitlement ids to be excluded. | [optional] +**freshness** | **int** | The freshness of a potential role. | [optional] +**identity_count** | **int** | The number of identities in a potential role. | [optional] +**identity_distribution** | [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**identity_ids** | **[]str** | The list of ids in a potential role. | [optional] +**name** | **str** | Name of the potential role. | [optional] +**provision_state** | [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**quality** | **int** | The quality of a potential role. | [optional] +**role_id** | **str** | The roleId of a potential role. | [optional] +**saved** | **bool** | The potential role's saved status. | [optional] +**session** | [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**id** | **str** | Id of the potential role | [optional] +**created_date** | **datetime** | The date-time when this potential role was created. | [optional] +**modified_date** | **datetime** | The date-time when this potential role was modified. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole + +role_mining_potential_role = RoleMiningPotentialRole( +created_by=, +density=75, +description='Potential Role for Accounting dept', +entitlement_count=25, +excluded_entitlements=[07a0b4e2, 13b4e2a0], +freshness=75, +identity_count=25, +identity_distribution=[ + sailpoint.beta.models.role_mining_identity_distribution.RoleMiningIdentityDistribution( + attribute_name = 'department', + distribution = [{attributeValue=NM Tier 3, count=6}], ) + ], +identity_ids=[07a0b4e2, 13b4e2a0], +name='Saved Potential Role - 07/10', +provision_state='POTENTIAL', +quality=100, +role_id='07a0b4e2-7a76-44fa-bd0b-c64654b66519', +saved=True, +session=sailpoint.beta.models.role_mining_session_parameters_dto.RoleMiningSessionParametersDto( + id = '9f36f5e5-1e81-4eca-b087-548959d91c71', + name = 'Saved RM Session - 07/10', + min_num_identities_in_potential_role = 20, + prune_threshold = 5, + saved = True, + scope = sailpoint.beta.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), + type = 'SPECIALIZED', + state = 'CREATED', + scoping_method = 'MANUAL', ), +type='SPECIALIZED', +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..f236508fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,35 @@ +--- +id: beta-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleApplication', 'BetaRoleMiningPotentialRoleApplication'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'BetaRoleMiningPotentialRoleApplication'] +--- + +# RoleMiningPotentialRoleApplication + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the application | [optional] +**name** | **str** | Name of the application | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication + +role_mining_potential_role_application = RoleMiningPotentialRoleApplication( +id='{id=2c9180877212632a017228d5a796292b}', +name='{name=Slack}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..6fa65fde1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'BetaRoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'BetaRoleMiningPotentialRoleEditEntitlements'] +--- + +# RoleMiningPotentialRoleEditEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The list of entitlement ids to be edited | [optional] +**exclude** | **bool** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements + +role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements( +ids=[ + '' + ], +exclude=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..f46e61012 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,35 @@ +--- +id: beta-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'BetaRoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'BetaRoleMiningPotentialRoleEntitlements'] +--- + +# RoleMiningPotentialRoleEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the entitlement | [optional] +**name** | **str** | Name of the entitlement | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements + +role_mining_potential_role_entitlements = RoleMiningPotentialRoleEntitlements( +id='{id=2c9180877212632a017228d5a796292c}', +name='{name=LauncherTest2}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..ce59110d3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'BetaRoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'BetaRoleMiningPotentialRoleExportRequest'] +--- + +# RoleMiningPotentialRoleExportRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min_entitlement_popularity** | **int** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**include_common_access** | **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest + +role_mining_potential_role_export_request = RoleMiningPotentialRoleExportRequest( +min_entitlement_popularity=0, +include_common_access=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..7138debe8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'BetaRoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'BetaRoleMiningPotentialRoleExportResponse'] +--- + +# RoleMiningPotentialRoleExportResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min_entitlement_popularity** | **int** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**include_common_access** | **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**export_id** | **str** | ID used to reference this export | [optional] +**status** | [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse + +role_mining_potential_role_export_response = RoleMiningPotentialRoleExportResponse( +min_entitlement_popularity=0, +include_common_access=True, +export_id='0c6cdb76-1227-4aaf-af21-192dbdfbfa04', +status='QUEUED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..4d666fc96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,26 @@ +--- +id: beta-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleExportState', 'BetaRoleMiningPotentialRoleExportState'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'BetaRoleMiningPotentialRoleExportState'] +--- + +# RoleMiningPotentialRoleExportState + + +## Enum + +* `QUEUED` (value: `'QUEUED'`) + +* `IN_PROGRESS` (value: `'IN_PROGRESS'`) + +* `SUCCESS` (value: `'SUCCESS'`) + +* `ERROR` (value: `'ERROR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..c79868504 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,41 @@ +--- +id: beta-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'BetaRoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'BetaRoleMiningPotentialRoleProvisionRequest'] +--- + +# RoleMiningPotentialRoleProvisionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_name** | **str** | Name of the new role being created | [optional] +**role_description** | **str** | Short description of the new role being created | [optional] +**owner_id** | **str** | ID of the identity that will own this role | [optional] +**include_identities** | **bool** | When true, create access requests for the identities associated with the potential role | [optional] [default to False] +**directly_assigned_entitlements** | **bool** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest + +role_mining_potential_role_provision_request = RoleMiningPotentialRoleProvisionRequest( +role_name='Finance - Accounting', +role_description='General access for accounting department', +owner_id='2b568c65bc3c4c57a43bd97e3a8e41', +include_identities=True, +directly_assigned_entitlements=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..4cbd2b08e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,27 @@ +--- +id: beta-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'BetaRoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'BetaRoleMiningPotentialRoleProvisionState'] +--- + +# RoleMiningPotentialRoleProvisionState + +Provision state + +## Enum + +* `POTENTIAL` (value: `'POTENTIAL'`) + +* `PENDING` (value: `'PENDING'`) + +* `COMPLETE` (value: `'COMPLETE'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..040323a1b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,35 @@ +--- +id: beta-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleRef', 'BetaRoleMiningPotentialRoleRef'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'BetaRoleMiningPotentialRoleRef'] +--- + +# RoleMiningPotentialRoleRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the potential role | [optional] +**name** | **str** | Name of the potential role | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_ref import RoleMiningPotentialRoleRef + +role_mining_potential_role_ref = RoleMiningPotentialRoleRef( +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +name='Potential Role - e0cc5d' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..f991bf812 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,39 @@ +--- +id: beta-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'BetaRoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'BetaRoleMiningPotentialRoleSourceUsage'] +--- + +# RoleMiningPotentialRoleSourceUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**display_name** | **str** | Display name for the identity | [optional] +**email** | **str** | Email address for the identity | [optional] +**usage_count** | **int** | The number of days there has been usage of the source by the identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage + +role_mining_potential_role_source_usage = RoleMiningPotentialRoleSourceUsage( +id='2c918089762475180176267f894b54dc', +display_name='Kirk Koepp', +email='kirk.koepp@testmail.identitynow.com', +usage_count=25 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..1e4788b1b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,79 @@ +--- +id: beta-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleSummary', 'BetaRoleMiningPotentialRoleSummary'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'BetaRoleMiningPotentialRoleSummary'] +--- + +# RoleMiningPotentialRoleSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the potential role | [optional] +**name** | **str** | Name of the potential role | [optional] +**potential_role_ref** | [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**identity_count** | **int** | The number of identities in a potential role. | [optional] +**entitlement_count** | **int** | The number of entitlements in a potential role. | [optional] +**identity_group_status** | **str** | The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" | [optional] +**provision_state** | [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**role_id** | **str** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**density** | **int** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**freshness** | **int** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**quality** | **int** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**created_by** | [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**created_date** | **datetime** | The date-time when this potential role was created. | [optional] +**saved** | **bool** | The potential role's saved status | [optional] [default to False] +**description** | **str** | Description of the potential role | [optional] +**session** | [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + +role_mining_potential_role_summary = RoleMiningPotentialRoleSummary( +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +name='Potential Role - e0cc5d', +potential_role_ref=sailpoint.beta.models.role_mining_potential_role_ref.RoleMiningPotentialRoleRef( + id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', + name = 'Potential Role - e0cc5d', ), +identity_count=25, +entitlement_count=15, +identity_group_status='OBTAINED', +provision_state='POTENTIAL', +role_id='2a4be6fbcf3c4e66b95a0c15ffd591', +density=90, +freshness=70, +quality=80, +type='SPECIALIZED', +created_by=, +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +saved=True, +description='', +session=sailpoint.beta.models.role_mining_session_parameters_dto.RoleMiningSessionParametersDto( + id = '9f36f5e5-1e81-4eca-b087-548959d91c71', + name = 'Saved RM Session - 07/10', + min_num_identities_in_potential_role = 20, + prune_threshold = 5, + saved = True, + scope = sailpoint.beta.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), + type = 'SPECIALIZED', + state = 'CREATED', + scoping_method = 'MANUAL', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..a0b0ba747 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,36 @@ +--- +id: beta-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'BetaRoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/python/beta/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'BetaRoleMiningPotentialRoleSummaryCreatedBy'] +--- + +# RoleMiningPotentialRoleSummaryCreatedBy + +The potential role created by details + +## 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.beta.models.role_mining_potential_role_summary_created_by import RoleMiningPotentialRoleSummaryCreatedBy + +role_mining_potential_role_summary_created_by = RoleMiningPotentialRoleSummaryCreatedBy( +id='2c918090761a5aac0176215c46a62d58', +display_name='Ashley.Pierce' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningRoleType.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..f3079a1b6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningRoleType.md @@ -0,0 +1,23 @@ +--- +id: beta-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningRoleType', 'BetaRoleMiningRoleType'] +slug: /tools/sdk/python/beta/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'BetaRoleMiningRoleType'] +--- + +# RoleMiningRoleType + +Role type + +## Enum + +* `SPECIALIZED` (value: `'SPECIALIZED'`) + +* `COMMON` (value: `'COMMON'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..02594bd33 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,51 @@ +--- +id: beta-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionDraftRoleDto', 'BetaRoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/python/beta/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'BetaRoleMiningSessionDraftRoleDto'] +--- + +# RoleMiningSessionDraftRoleDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the draft role | [optional] +**description** | **str** | Draft role description | [optional] +**identity_ids** | **[]str** | The list of identities for this role mining session. | [optional] +**entitlement_ids** | **[]str** | The list of entitlement ids for this role mining session. | [optional] +**excluded_entitlements** | **[]str** | The list of excluded entitlement ids. | [optional] +**modified** | **datetime** | Last modified date | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**id** | **str** | Id of the potential draft role | [optional] +**created_date** | **datetime** | The date-time when this potential draft role was created. | [optional] +**modified_date** | **datetime** | The date-time when this potential draft role was modified. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto + +role_mining_session_draft_role_dto = RoleMiningSessionDraftRoleDto( +name='Saved RM Session - 07/10', +description='Person who develops software', +identity_ids=[2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], +entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e], +excluded_entitlements=[07a0b4e2, 13b4e2a0], +modified='2020-09-16T18:49:32.150Z', +type='SPECIALIZED', +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..d297ec5c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionDto.md @@ -0,0 +1,56 @@ +--- +id: beta-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionDto', 'BetaRoleMiningSessionDto'] +slug: /tools/sdk/python/beta/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'BetaRoleMiningSessionDto'] +--- + +# RoleMiningSessionDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**prune_threshold** | **int** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**prescribed_prune_threshold** | **int** | The calculated prescribedPruneThreshold | [optional] +**min_num_identities_in_potential_role** | **int** | Minimum number of identities in a potential role | [optional] +**potential_role_count** | **int** | Number of potential roles | [optional] +**potential_roles_ready_count** | **int** | Number of potential roles ready | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**email_recipient_id** | **str** | The id of the user who will receive an email about the role mining session | [optional] +**identity_count** | **int** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**saved** | **bool** | The session's saved status | [optional] [default to False] +**name** | **str** | The session's saved name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_session_dto import RoleMiningSessionDto + +role_mining_session_dto = RoleMiningSessionDto( +scope=sailpoint.beta.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), +prune_threshold=50, +prescribed_prune_threshold=10, +min_num_identities_in_potential_role=20, +potential_role_count=0, +potential_roles_ready_count=0, +type='SPECIALIZED', +email_recipient_id='2c918090761a5aac0176215c46a62d58', +identity_count=0, +saved=True, +name='Saved RM Session - 07/10' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..e57fdea69 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,52 @@ +--- +id: beta-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionParametersDto', 'BetaRoleMiningSessionParametersDto'] +slug: /tools/sdk/python/beta/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'BetaRoleMiningSessionParametersDto'] +--- + +# RoleMiningSessionParametersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the role mining session | [optional] +**name** | **str** | The session's saved name | [optional] +**min_num_identities_in_potential_role** | **int** | Minimum number of identities in a potential role | [optional] +**prune_threshold** | **int** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**saved** | **bool** | The session's saved status | [optional] [default to True] +**scope** | [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**state** | [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**scoping_method** | [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_session_parameters_dto import RoleMiningSessionParametersDto + +role_mining_session_parameters_dto = RoleMiningSessionParametersDto( +id='9f36f5e5-1e81-4eca-b087-548959d91c71', +name='Saved RM Session - 07/10', +min_num_identities_in_potential_role=20, +prune_threshold=5, +saved=True, +scope=sailpoint.beta.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), +type='SPECIALIZED', +state='CREATED', +scoping_method='MANUAL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..06a5758e1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionResponse.md @@ -0,0 +1,71 @@ +--- +id: beta-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionResponse', 'BetaRoleMiningSessionResponse'] +slug: /tools/sdk/python/beta/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'BetaRoleMiningSessionResponse'] +--- + +# RoleMiningSessionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**min_num_identities_in_potential_role** | **int** | Minimum number of identities in a potential role | [optional] +**scoping_method** | **str** | The scoping method of the role mining session | [optional] +**prescribed_prune_threshold** | **int** | The computed (or prescribed) prune threshold for this session | [optional] +**prune_threshold** | **int** | The prune threshold to be used for this role mining session | [optional] +**potential_role_count** | **int** | The number of potential roles | [optional] +**potential_roles_ready_count** | **int** | The number of potential roles which have completed processing | [optional] +**status** | [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**email_recipient_id** | **str** | The id of the user who will receive an email about the role mining session | [optional] +**created_by** | [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**identity_count** | **int** | The number of identities | [optional] +**saved** | **bool** | The session's saved status | [optional] [default to False] +**name** | **str** | The session's saved name | [optional] +**data_file_path** | **str** | The data file path of the role mining session | [optional] +**id** | **str** | Session Id for this role mining session | [optional] +**created_date** | **datetime** | The date-time when this role mining session was created. | [optional] +**modified_date** | **datetime** | The date-time when this role mining session was completed. | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse + +role_mining_session_response = RoleMiningSessionResponse( +scope=sailpoint.beta.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), +min_num_identities_in_potential_role=20, +scoping_method='AUTO_RM', +prescribed_prune_threshold=83, +prune_threshold=70, +potential_role_count=8, +potential_roles_ready_count=4, +status=sailpoint.beta.models.role_mining_session_status.RoleMiningSessionStatus( + state = 'CREATED', ), +email_recipient_id='', +created_by=, +identity_count=39, +saved=True, +name='Saved RM Session - 07/10', +data_file_path='', +id='8c190e67-87aa-4ed9-a90b-d9d5344523fb', +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +type='SPECIALIZED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..c2fdea152 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,36 @@ +--- +id: beta-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'BetaRoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/python/beta/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'BetaRoleMiningSessionResponseCreatedBy'] +--- + +# RoleMiningSessionResponseCreatedBy + +The session created by details + +## 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.beta.models.role_mining_session_response_created_by import RoleMiningSessionResponseCreatedBy + +role_mining_session_response_created_by = RoleMiningSessionResponseCreatedBy( +id='2c918090761a5aac0176215c46a62d58', +display_name='Ashley.Pierce' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionScope.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..350f5a2d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionScope.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionScope', 'BetaRoleMiningSessionScope'] +slug: /tools/sdk/python/beta/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'BetaRoleMiningSessionScope'] +--- + +# RoleMiningSessionScope + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_ids** | **[]str** | The list of identities for this role mining session. | [optional] +**criteria** | **str** | The \"search\" criteria that produces the list of identities for this role mining session. | [optional] +**attribute_filter_criteria** | **[]object** | The filter criteria for this role mining session. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_session_scope import RoleMiningSessionScope + +role_mining_session_scope = RoleMiningSessionScope( +identity_ids=[2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], +criteria='source.name:DataScienceDataset', +attribute_filter_criteria={displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..4d0b2fa91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,23 @@ +--- +id: beta-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionScopingMethod', 'BetaRoleMiningSessionScopingMethod'] +slug: /tools/sdk/python/beta/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'BetaRoleMiningSessionScopingMethod'] +--- + +# RoleMiningSessionScopingMethod + +The scoping method used in the current role mining session. + +## Enum + +* `MANUAL` (value: `'MANUAL'`) + +* `AUTO_RM` (value: `'AUTO_RM'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionState.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..961a75798 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionState.md @@ -0,0 +1,31 @@ +--- +id: beta-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionState', 'BetaRoleMiningSessionState'] +slug: /tools/sdk/python/beta/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'BetaRoleMiningSessionState'] +--- + +# RoleMiningSessionState + +Role mining session status + +## Enum + +* `CREATED` (value: `'CREATED'`) + +* `UPDATED` (value: `'UPDATED'`) + +* `IDENTITIES_OBTAINED` (value: `'IDENTITIES_OBTAINED'`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `'PRUNE_THRESHOLD_OBTAINED'`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `'POTENTIAL_ROLES_PROCESSING'`) + +* `POTENTIAL_ROLES_CREATED` (value: `'POTENTIAL_ROLES_CREATED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..1d825850a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleMiningSessionStatus.md @@ -0,0 +1,33 @@ +--- +id: beta-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionStatus', 'BetaRoleMiningSessionStatus'] +slug: /tools/sdk/python/beta/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'BetaRoleMiningSessionStatus'] +--- + +# RoleMiningSessionStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_mining_session_status import RoleMiningSessionStatus + +role_mining_session_status = RoleMiningSessionStatus( +state='CREATED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RoleTargetDto.md b/docs/tools/sdk/python/Reference/Beta/Models/RoleTargetDto.md new file mode 100644 index 000000000..7ec4e9170 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RoleTargetDto.md @@ -0,0 +1,42 @@ +--- +id: beta-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleTargetDto', 'BetaRoleTargetDto'] +slug: /tools/sdk/python/beta/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'BetaRoleTargetDto'] +--- + +# RoleTargetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**account_info** | [**AccountInfoDto**](account-info-dto) | | [optional] +**role_name** | **str** | Specific role name for this target if using multiple accounts | [optional] +} + +## Example + +```python +from sailpoint.beta.models.role_target_dto import RoleTargetDto + +role_target_dto = RoleTargetDto( +source=sailpoint.beta.models.base_reference_dto_1.BaseReferenceDto_1( + id = 'ff8081814d977c21014da056804a0af3', + name = 'Github', ), +account_info=sailpoint.beta.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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchComplete.md b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchComplete.md new file mode 100644 index 000000000..cf2351f15 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchComplete.md @@ -0,0 +1,63 @@ +--- +id: beta-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchComplete', 'BetaSavedSearchComplete'] +slug: /tools/sdk/python/beta/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'BetaSavedSearchComplete'] +--- + +# SavedSearchComplete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_name** | **str** | A name for the report file. | [required] +**owner_email** | **str** | The email address of the identity that owns the saved search. | [required] +**owner_name** | **str** | The name of the identity that owns the saved search. | [required] +**query** | **str** | The search query that was used to generate the report. | [required] +**search_name** | **str** | The name of the saved search. | [required] +**search_results** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**signed_s3_url** | **str** | The Amazon S3 URL to download the report from. | [required] +} + +## Example + +```python +from sailpoint.beta.models.saved_search_complete import SavedSearchComplete + +saved_search_complete = SavedSearchComplete( +file_name='Modified.zip', +owner_email='test@sailpoint.com', +owner_name='Cloud Support', +query='modified:[now-7y/d TO now]', +search_name='Modified Activity', +search_results=sailpoint.beta.models.saved_search_complete_search_results.SavedSearchComplete_searchResults( + account = sailpoint.beta.models.saved_search_complete_search_results_account.SavedSearchComplete_searchResults_Account( + count = '3', + noun = 'accounts', + preview = [ + [] + ], ), + entitlement = sailpoint.beta.models.saved_search_complete_search_results_entitlement.SavedSearchComplete_searchResults_Entitlement( + count = '2', + noun = 'entitlements', + preview = [ + [] + ], ), + identity = sailpoint.beta.models.saved_search_complete_search_results_identity.SavedSearchComplete_searchResults_Identity( + count = '2', + noun = 'identities', + preview = [ + [] + ], ), ), +signed_s3_url='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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..6c25e26a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,53 @@ +--- +id: beta-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResults', 'BetaSavedSearchCompleteSearchResults'] +slug: /tools/sdk/python/beta/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'BetaSavedSearchCompleteSearchResults'] +--- + +# SavedSearchCompleteSearchResults + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account** | [**SavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**entitlement** | [**SavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**identity** | [**SavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.saved_search_complete_search_results import SavedSearchCompleteSearchResults + +saved_search_complete_search_results = SavedSearchCompleteSearchResults( +account=sailpoint.beta.models.saved_search_complete_search_results_account.SavedSearchComplete_searchResults_Account( + count = '3', + noun = 'accounts', + preview = [ + [] + ], ), +entitlement=sailpoint.beta.models.saved_search_complete_search_results_entitlement.SavedSearchComplete_searchResults_Entitlement( + count = '2', + noun = 'entitlements', + preview = [ + [] + ], ), +identity=sailpoint.beta.models.saved_search_complete_search_results_identity.SavedSearchComplete_searchResults_Identity( + count = '2', + noun = 'identities', + preview = [ + [] + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..d3117bb37 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,40 @@ +--- +id: beta-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'BetaSavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/python/beta/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'BetaSavedSearchCompleteSearchResultsAccount'] +--- + +# SavedSearchCompleteSearchResultsAccount + +A table of accounts that match the search criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **str** | The number of rows in the table. | [required] +**noun** | **str** | The type of object represented in the table. | [required] +**preview** | **[]List[str]** | A sample of the data in the table. | [required] +} + +## Example + +```python +from sailpoint.beta.models.saved_search_complete_search_results_account import SavedSearchCompleteSearchResultsAccount + +saved_search_complete_search_results_account = SavedSearchCompleteSearchResultsAccount( +count='3', +noun='accounts', +preview=[ + [] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..3eb95d8e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,40 @@ +--- +id: beta-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'BetaSavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/python/beta/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'BetaSavedSearchCompleteSearchResultsEntitlement'] +--- + +# SavedSearchCompleteSearchResultsEntitlement + +A table of entitlements that match the search criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **str** | The number of rows in the table. | [required] +**noun** | **str** | The type of object represented in the table. | [required] +**preview** | **[]List[str]** | A sample of the data in the table. | [required] +} + +## Example + +```python +from sailpoint.beta.models.saved_search_complete_search_results_entitlement import SavedSearchCompleteSearchResultsEntitlement + +saved_search_complete_search_results_entitlement = SavedSearchCompleteSearchResultsEntitlement( +count='2', +noun='entitlements', +preview=[ + [] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..87f82785c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,40 @@ +--- +id: beta-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'BetaSavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/python/beta/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'BetaSavedSearchCompleteSearchResultsIdentity'] +--- + +# SavedSearchCompleteSearchResultsIdentity + +A table of identities that match the search criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **str** | The number of rows in the table. | [required] +**noun** | **str** | The type of object represented in the table. | [required] +**preview** | **[]List[str]** | A sample of the data in the table. | [required] +} + +## Example + +```python +from sailpoint.beta.models.saved_search_complete_search_results_identity import SavedSearchCompleteSearchResultsIdentity + +saved_search_complete_search_results_identity = SavedSearchCompleteSearchResultsIdentity( +count='2', +noun='identities', +preview=[ + [] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Schedule.md b/docs/tools/sdk/python/Reference/Beta/Models/Schedule.md new file mode 100644 index 000000000..1bc17ef99 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Schedule.md @@ -0,0 +1,52 @@ +--- +id: beta-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule', 'BetaSchedule'] +slug: /tools/sdk/python/beta/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'BetaSchedule'] +--- + +# Schedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WEEKLY', 'MONTHLY', 'ANNUALLY', 'CALENDAR' ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] +**months** | [**ScheduleMonths**](schedule-months) | | [optional] +**days** | [**ScheduleDays**](schedule-days) | | [optional] +**hours** | [**ScheduleHours**](schedule-hours) | | [required] +**expiration** | **datetime** | Specifies the time after which this schedule will no longer occur. | [optional] +**time_zone_id** | **str** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule import Schedule + +schedule = Schedule( +type='WEEKLY', +months=sailpoint.beta.models.schedule_months.Schedule_months( + type = 'LIST', + values = [1], + interval = 2, ), +days=sailpoint.beta.models.schedule_days.Schedule_days( + type = 'LIST', + values = [1], + interval = 2, ), +hours=sailpoint.beta.models.schedule_hours.Schedule_hours( + type = 'LIST', + values = [1], + interval = 2, ), +expiration=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +time_zone_id='CST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Schedule1.md b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1.md new file mode 100644 index 000000000..9fd326ad8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1.md @@ -0,0 +1,44 @@ +--- +id: beta-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1', 'BetaSchedule1'] +slug: /tools/sdk/python/beta/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'BetaSchedule1'] +--- + +# Schedule1 + +The schedule information. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ScheduleType**](schedule-type) | | [required] +**months** | [**Schedule1Months**](schedule1-months) | | [optional] +**days** | [**Schedule1Days**](schedule1-days) | | [optional] +**hours** | [**Schedule1Hours**](schedule1-hours) | | [required] +**expiration** | **datetime** | A date-time in ISO-8601 format | [optional] +**time_zone_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule1 import Schedule1 + +schedule1 = Schedule1( +type='WEEKLY', +months=, +days=, +hours=, +expiration='2018-06-25T20:22:28.104Z', +time_zone_id='America/Chicago' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Days.md b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Days.md new file mode 100644 index 000000000..e6fe99b1a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Days.md @@ -0,0 +1,38 @@ +--- +id: beta-schedule1-days +title: Schedule1Days +pagination_label: Schedule1Days +sidebar_label: Schedule1Days +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1Days', 'BetaSchedule1Days'] +slug: /tools/sdk/python/beta/models/schedule1-days +tags: ['SDK', 'Software Development Kit', 'Schedule1Days', 'BetaSchedule1Days'] +--- + +# Schedule1Days + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule1_days import Schedule1Days + +schedule1_days = Schedule1Days( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Hours.md b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Hours.md new file mode 100644 index 000000000..157e8d4d9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Hours.md @@ -0,0 +1,38 @@ +--- +id: beta-schedule1-hours +title: Schedule1Hours +pagination_label: Schedule1Hours +sidebar_label: Schedule1Hours +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1Hours', 'BetaSchedule1Hours'] +slug: /tools/sdk/python/beta/models/schedule1-hours +tags: ['SDK', 'Software Development Kit', 'Schedule1Hours', 'BetaSchedule1Hours'] +--- + +# Schedule1Hours + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule1_hours import Schedule1Hours + +schedule1_hours = Schedule1Hours( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Months.md b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Months.md new file mode 100644 index 000000000..39c7f0bdc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Schedule1Months.md @@ -0,0 +1,38 @@ +--- +id: beta-schedule1-months +title: Schedule1Months +pagination_label: Schedule1Months +sidebar_label: Schedule1Months +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1Months', 'BetaSchedule1Months'] +slug: /tools/sdk/python/beta/models/schedule1-months +tags: ['SDK', 'Software Development Kit', 'Schedule1Months', 'BetaSchedule1Months'] +--- + +# Schedule1Months + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule1_months import Schedule1Months + +schedule1_months = Schedule1Months( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ScheduleDays.md b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleDays.md new file mode 100644 index 000000000..530a65f34 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleDays.md @@ -0,0 +1,38 @@ +--- +id: beta-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleDays', 'BetaScheduleDays'] +slug: /tools/sdk/python/beta/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'BetaScheduleDays'] +--- + +# ScheduleDays + +Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify days value | [required] +**values** | **[]str** | Values of the days based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule_days import ScheduleDays + +schedule_days = ScheduleDays( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ScheduleHours.md b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleHours.md new file mode 100644 index 000000000..7a31571af --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleHours.md @@ -0,0 +1,38 @@ +--- +id: beta-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleHours', 'BetaScheduleHours'] +slug: /tools/sdk/python/beta/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'BetaScheduleHours'] +--- + +# ScheduleHours + +Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify hours value | [required] +**values** | **[]str** | Values of the days based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule_hours import ScheduleHours + +schedule_hours = ScheduleHours( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ScheduleMonths.md b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleMonths.md new file mode 100644 index 000000000..25723bf9b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleMonths.md @@ -0,0 +1,38 @@ +--- +id: beta-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleMonths', 'BetaScheduleMonths'] +slug: /tools/sdk/python/beta/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'BetaScheduleMonths'] +--- + +# ScheduleMonths + +Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify months value | [required] +**values** | **[]str** | Values of the months based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.beta.models.schedule_months import ScheduleMonths + +schedule_months = ScheduleMonths( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ScheduleType.md b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleType.md new file mode 100644 index 000000000..52bf5840d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ScheduleType.md @@ -0,0 +1,29 @@ +--- +id: beta-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleType', 'BetaScheduleType'] +slug: /tools/sdk/python/beta/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'BetaScheduleType'] +--- + +# ScheduleType + +Enum representing the currently supported schedule types. Additional values may be added in the future without notice. + +## Enum + +* `DAILY` (value: `'DAILY'`) + +* `WEEKLY` (value: `'WEEKLY'`) + +* `MONTHLY` (value: `'MONTHLY'`) + +* `CALENDAR` (value: `'CALENDAR'`) + +* `ANNUALLY` (value: `'ANNUALLY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ScheduledAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/ScheduledAttributes.md new file mode 100644 index 000000000..58118e33c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ScheduledAttributes.md @@ -0,0 +1,42 @@ +--- +id: beta-scheduled-attributes +title: ScheduledAttributes +pagination_label: ScheduledAttributes +sidebar_label: ScheduledAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledAttributes', 'BetaScheduledAttributes'] +slug: /tools/sdk/python/beta/models/scheduled-attributes +tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes', 'BetaScheduledAttributes'] +--- + +# ScheduledAttributes + +Attributes related to a scheduled trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required] +**time_zone** | **str** | Time zone identifier | [optional] +**cron_string** | **str** | | [optional] +**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional] +**weekly_times** | **[]str** | Scheduled execution times | [optional] +} + +## Example + +```python +from sailpoint.beta.models.scheduled_attributes import ScheduledAttributes + +scheduled_attributes = ScheduledAttributes( +frequency='daily', +time_zone='America/Chicago', +cron_string='0 9 * * 1', +weekly_days=Monday, +weekly_times=Monday +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SearchAttributeConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..f6b5650dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SearchAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchAttributeConfig', 'BetaSearchAttributeConfig'] +slug: /tools/sdk/python/beta/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'BetaSearchAttributeConfig'] +--- + +# SearchAttributeConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the new attribute | [optional] +**display_name** | **str** | The display name of the new attribute | [optional] +**application_attributes** | **object** | Map of application id and their associated attribute. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig + +search_attribute_config = SearchAttributeConfig( +name='newMailAttribute', +display_name='New Mail Attribute', +application_attributes={2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/python/Reference/Beta/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..611c5756d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,44 @@ +--- +id: beta-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'BetaSearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/python/beta/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'BetaSearchFormDefinitionsByTenant400Response'] +--- + +# SearchFormDefinitionsByTenant400Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail_code** | **str** | | [optional] +**messages** | [**[]ErrorMessage**](error-message) | | [optional] +**status_code** | **int** | | [optional] +**tracking_id** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.search_form_definitions_by_tenant400_response import SearchFormDefinitionsByTenant400Response + +search_form_definitions_by_tenant400_response = SearchFormDefinitionsByTenant400Response( +detail_code='', +messages=[ + sailpoint.beta.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', ) + ], +status_code=56, +tracking_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Section.md b/docs/tools/sdk/python/Reference/Beta/Models/Section.md new file mode 100644 index 000000000..37ee8d87d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Section.md @@ -0,0 +1,37 @@ +--- +id: beta-section +title: Section +pagination_label: Section +sidebar_label: Section +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Section', 'BetaSection'] +slug: /tools/sdk/python/beta/models/section +tags: ['SDK', 'Software Development Kit', 'Section', 'BetaSection'] +--- + +# Section + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +**label** | **str** | Label of the section | [optional] +**form_items** | **[]object** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] +} + +## Example + +```python +from sailpoint.beta.models.section import Section + +section = Section( +name='Field1', +label='Section 1', +form_items=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SectionDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/SectionDetails.md new file mode 100644 index 000000000..9dc3116af --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SectionDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SectionDetails', 'BetaSectionDetails'] +slug: /tools/sdk/python/beta/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'BetaSectionDetails'] +--- + +# SectionDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +**label** | **str** | Label of the section | [optional] +**form_items** | **[]object** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] +} + +## Example + +```python +from sailpoint.beta.models.section_details import SectionDetails + +section_details = SectionDetails( +name='Field1', +label='Section 1', +form_items=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Sed.md b/docs/tools/sdk/python/Reference/Beta/Models/Sed.md new file mode 100644 index 000000000..e1f85b198 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Sed.md @@ -0,0 +1,60 @@ +--- +id: beta-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Sed', 'BetaSed'] +slug: /tools/sdk/python/beta/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'BetaSed'] +--- + +# Sed + +Suggested Entitlement Description + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | name of the entitlement | [optional] +**approved_by** | **str** | entitlement approved by | [optional] +**approved_type** | **str** | entitlement approved type | [optional] +**approved_when** | **datetime** | entitlement approved then | [optional] +**attribute** | **str** | entitlement attribute | [optional] +**description** | **str** | description of entitlement | [optional] +**display_name** | **str** | entitlement display name | [optional] +**id** | **str** | sed id | [optional] +**source_id** | **str** | entitlement source id | [optional] +**source_name** | **str** | entitlement source name | [optional] +**status** | **str** | entitlement status | [optional] +**suggested_description** | **str** | llm suggested entitlement description | [optional] +**type** | **str** | entitlement type | [optional] +**value** | **str** | entitlement value | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed import Sed + +sed = Sed( +name='BatchInvoiceProcessing', +approved_by='2c918086-76de-afbf-0176-f6d28f65565a', +approved_type='admin', +approved_when=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +attribute='Role', +description='This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures.', +display_name='AWS-Cloud-Billing', +id='ead281ee-12a9-40ac-9534-36b5d7d65d53', +source_id='103f567b93ee49b991c40f9412f87643', +source_name='IDN Salesforce', +status='suggested', +suggested_description='This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable', +type='group', +value='group' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedApproval.md b/docs/tools/sdk/python/Reference/Beta/Models/SedApproval.md new file mode 100644 index 000000000..a6d048435 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedApproval.md @@ -0,0 +1,34 @@ +--- +id: beta-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedApproval', 'BetaSedApproval'] +slug: /tools/sdk/python/beta/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'BetaSedApproval'] +--- + +# SedApproval + +Sed Approval Request Body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **[]str** | List of SED id's | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_approval import SedApproval + +sed_approval = SedApproval( +items=016629d1-1d25-463f-97f3-c6686846650 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedApprovalStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/SedApprovalStatus.md new file mode 100644 index 000000000..64e062af0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedApprovalStatus.md @@ -0,0 +1,38 @@ +--- +id: beta-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedApprovalStatus', 'BetaSedApprovalStatus'] +slug: /tools/sdk/python/beta/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'BetaSedApprovalStatus'] +--- + +# SedApprovalStatus + +SED Approval Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**failed_reason** | **str** | failed reason will be display if status is failed | [optional] +**id** | **str** | Sed id | [optional] +**status** | **str** | SUCCESS | FAILED | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_approval_status import SedApprovalStatus + +sed_approval_status = SedApprovalStatus( +failed_reason='invalid status', +id='016629d1-1d25-463f-97f3-0c6686846650', +status='SUCCESS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedAssignee.md b/docs/tools/sdk/python/Reference/Beta/Models/SedAssignee.md new file mode 100644 index 000000000..92d33f12d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedAssignee.md @@ -0,0 +1,36 @@ +--- +id: beta-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedAssignee', 'BetaSedAssignee'] +slug: /tools/sdk/python/beta/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'BetaSedAssignee'] +--- + +# SedAssignee + +Sed Assignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GROUP', 'SOURCE_OWNER', 'ENTITLEMENT_OWNER' ] | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | [required] +**value** | **str** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_assignee import SedAssignee + +sed_assignee = SedAssignee( +type='SOURCE_OWNER', +value='016629d1-1d25-463f-97f3-c6686846650' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedAssignment.md b/docs/tools/sdk/python/Reference/Beta/Models/SedAssignment.md new file mode 100644 index 000000000..0e3da08fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedAssignment.md @@ -0,0 +1,40 @@ +--- +id: beta-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedAssignment', 'BetaSedAssignment'] +slug: /tools/sdk/python/beta/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'BetaSedAssignment'] +--- + +# SedAssignment + +Sed Assignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignee** | [**SedAssignee**](sed-assignee) | | [optional] +**items** | **[]str** | List of SED id's | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_assignment import SedAssignment + +sed_assignment = SedAssignment( +assignee=sailpoint.beta.models.sed_assignee.SedAssignee( + type = 'SOURCE_OWNER', + value = '016629d1-1d25-463f-97f3-c6686846650', ), +items=[ + '016629d1-1d25-463f-97f3-0c6686846650' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedAssignmentResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..4901efed9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedAssignmentResponse.md @@ -0,0 +1,34 @@ +--- +id: beta-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedAssignmentResponse', 'BetaSedAssignmentResponse'] +slug: /tools/sdk/python/beta/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'BetaSedAssignmentResponse'] +--- + +# SedAssignmentResponse + +Sed Assignment Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_id** | **str** | BatchId that groups all the ids together | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_assignment_response import SedAssignmentResponse + +sed_assignment_response = SedAssignmentResponse( +batch_id='016629d1-1d25-463f-97f3-0c6686846650' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedBatchRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchRequest.md new file mode 100644 index 000000000..b2bc3bf4e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchRequest.md @@ -0,0 +1,40 @@ +--- +id: beta-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchRequest', 'BetaSedBatchRequest'] +slug: /tools/sdk/python/beta/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'BetaSedBatchRequest'] +--- + +# SedBatchRequest + +Sed Batch Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlements** | **[]str** | list of entitlement ids | [optional] +**seds** | **[]str** | list of sed ids | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_batch_request import SedBatchRequest + +sed_batch_request = SedBatchRequest( +entitlements=[ + '016629d1-1d25-463f-97f3-c6686846650' + ], +seds=[ + '016629d1-1d25-463f-97f3-c6686846650' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedBatchResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchResponse.md new file mode 100644 index 000000000..11c55d02d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchResponse.md @@ -0,0 +1,34 @@ +--- +id: beta-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchResponse', 'BetaSedBatchResponse'] +slug: /tools/sdk/python/beta/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'BetaSedBatchResponse'] +--- + +# SedBatchResponse + +Sed Batch Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_id** | **str** | BatchId that groups all the ids together | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_batch_response import SedBatchResponse + +sed_batch_response = SedBatchResponse( +batch_id='016629d1-1d25-463f-97f3-0c6686846650' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedBatchStats.md b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchStats.md new file mode 100644 index 000000000..d348b732d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchStats.md @@ -0,0 +1,42 @@ +--- +id: beta-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchStats', 'BetaSedBatchStats'] +slug: /tools/sdk/python/beta/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'BetaSedBatchStats'] +--- + +# SedBatchStats + +Sed Batch Stats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_complete** | **bool** | batch complete | [optional] [default to False] +**batch_id** | **str** | batch Id | [optional] +**discovered_count** | **int** | discovered count | [optional] +**discovery_complete** | **bool** | discovery complete | [optional] [default to False] +**processed_count** | **int** | processed count | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_batch_stats import SedBatchStats + +sed_batch_stats = SedBatchStats( +batch_complete=True, +batch_id='016629d1-1d25-463f-97f3-0c6686846650', +discovered_count=100, +discovery_complete=True, +processed_count=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedBatchStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchStatus.md new file mode 100644 index 000000000..130cf1ce0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedBatchStatus.md @@ -0,0 +1,34 @@ +--- +id: beta-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchStatus', 'BetaSedBatchStatus'] +slug: /tools/sdk/python/beta/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'BetaSedBatchStatus'] +--- + +# SedBatchStatus + +Sed Batch Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | status of batch | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_batch_status import SedBatchStatus + +sed_batch_status = SedBatchStatus( +status='OK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SedPatch.md b/docs/tools/sdk/python/Reference/Beta/Models/SedPatch.md new file mode 100644 index 000000000..001426af5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SedPatch.md @@ -0,0 +1,38 @@ +--- +id: beta-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedPatch', 'BetaSedPatch'] +slug: /tools/sdk/python/beta/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'BetaSedPatch'] +--- + +# SedPatch + +Patch for Suggested Entitlement Description + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **str** | desired operation | [optional] +**path** | **str** | field to be patched | [optional] +**value** | **object** | value to replace with | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sed_patch import SedPatch + +sed_patch = SedPatch( +op='replace', +path='status', +value=approved +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Segment.md b/docs/tools/sdk/python/Reference/Beta/Models/Segment.md new file mode 100644 index 000000000..26caca565 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Segment.md @@ -0,0 +1,56 @@ +--- +id: beta-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Segment', 'BetaSegment'] +slug: /tools/sdk/python/beta/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'BetaSegment'] +--- + +# Segment + + +## 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] +**owner** | [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] +**visibility_criteria** | [**VisibilityCriteria**](visibility-criteria) | | [optional] +**active** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.segment import Segment + +segment = Segment( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='segment-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This segment represents xyz', +owner=sailpoint.beta.models.owner_reference_segments.OwnerReferenceSegments( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +visibility_criteria=sailpoint.beta.models.visibility_criteria.VisibilityCriteria( + expression = sailpoint.beta.models.expression.Expression( + operator = 'EQUALS', + attribute = 'location', + value = sailpoint.beta.models.value.Value( + type = 'STRING', ), + children = [], ), ), +active=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Selector.md b/docs/tools/sdk/python/Reference/Beta/Models/Selector.md new file mode 100644 index 000000000..469dad200 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Selector.md @@ -0,0 +1,38 @@ +--- +id: beta-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Selector', 'BetaSelector'] +slug: /tools/sdk/python/beta/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'BetaSelector'] +--- + +# Selector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.selector import Selector + +selector = Selector( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..3811c8483 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelectorAccountMatchConfig', 'BetaSelectorAccountMatchConfig'] +slug: /tools/sdk/python/beta/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'BetaSelectorAccountMatchConfig'] +--- + +# SelectorAccountMatchConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**match_expression** | [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.selector_account_match_config import SelectorAccountMatchConfig + +selector_account_match_config = SelectorAccountMatchConfig( +match_expression=sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/python/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..e415644c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,35 @@ +--- +id: beta-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'BetaSelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/python/beta/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'BetaSelectorAccountMatchConfigMatchExpression'] +--- + +# SelectorAccountMatchConfigMatchExpression + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**match_terms** | [**[]MatchTerm**](match-term) | | [optional] +**var_and** | **bool** | If it is AND operators for match terms | [optional] [default to True] +} + +## Example + +```python +from sailpoint.beta.models.selector_account_match_config_match_expression import SelectorAccountMatchConfigMatchExpression + +selector_account_match_config_match_expression = SelectorAccountMatchConfigMatchExpression( +match_terms=[{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], +var_and=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SelfImportExportDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SelfImportExportDto.md new file mode 100644 index 000000000..076b6fdb8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SelfImportExportDto.md @@ -0,0 +1,38 @@ +--- +id: beta-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelfImportExportDto', 'BetaSelfImportExportDto'] +slug: /tools/sdk/python/beta/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'BetaSelfImportExportDto'] +--- + +# SelfImportExportDto + +Self block for imported/exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **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' ] | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**id** | **str** | Imported/exported object's ID. | [optional] +**name** | **str** | Imported/exported object's display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.self_import_export_dto import SelfImportExportDto + +self_import_export_dto = SelfImportExportDto( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..a44d7bd0b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SendAccountVerificationRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendAccountVerificationRequest', 'BetaSendAccountVerificationRequest'] +slug: /tools/sdk/python/beta/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'BetaSendAccountVerificationRequest'] +--- + +# SendAccountVerificationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_name** | **str** | The source name where identity account password should be reset | [optional] +**via** | **Enum** [ 'EMAIL_WORK', 'EMAIL_PERSONAL', 'LINK_WORK', 'LINK_PERSONAL' ] | The method to send notification | [required] +} + +## Example + +```python +from sailpoint.beta.models.send_account_verification_request import SendAccountVerificationRequest + +send_account_verification_request = SendAccountVerificationRequest( +source_name='Active Directory Source', +via='EMAIL_WORK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..86816ed03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,37 @@ +--- +id: beta-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendTestNotificationRequestDto', 'BetaSendTestNotificationRequestDto'] +slug: /tools/sdk/python/beta/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'BetaSendTestNotificationRequestDto'] +--- + +# SendTestNotificationRequestDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The template notification key. | [optional] +**medium** | **Enum** [ 'EMAIL', 'SLACK', 'TEAMS' ] | The notification medium. Has to be one of the following enum values. | [optional] +**context** | **object** | A Json object that denotes the context specific to the template. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.send_test_notification_request_dto import SendTestNotificationRequestDto + +send_test_notification_request_dto = SendTestNotificationRequestDto( +key='cloud_manual_work_item_summary', +medium='EMAIL', +context=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SendTokenRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SendTokenRequest.md new file mode 100644 index 000000000..1373850d8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SendTokenRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-send-token-request +title: SendTokenRequest +pagination_label: SendTokenRequest +sidebar_label: SendTokenRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendTokenRequest', 'BetaSendTokenRequest'] +slug: /tools/sdk/python/beta/models/send-token-request +tags: ['SDK', 'Software Development Kit', 'SendTokenRequest', 'BetaSendTokenRequest'] +--- + +# SendTokenRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_alias** | **str** | User alias from table spt_identity field named 'name' | [required] +**delivery_type** | **Enum** [ 'SMS_PERSONAL', 'VOICE_PERSONAL', 'SMS_WORK', 'VOICE_WORK', 'EMAIL_WORK', 'EMAIL_PERSONAL' ] | Token delivery type | [required] +} + +## Example + +```python +from sailpoint.beta.models.send_token_request import SendTokenRequest + +send_token_request = SendTokenRequest( +user_alias='will.albin', +delivery_type='EMAIL_WORK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SendTokenResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/SendTokenResponse.md new file mode 100644 index 000000000..021d605bc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SendTokenResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-send-token-response +title: SendTokenResponse +pagination_label: SendTokenResponse +sidebar_label: SendTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendTokenResponse', 'BetaSendTokenResponse'] +slug: /tools/sdk/python/beta/models/send-token-response +tags: ['SDK', 'Software Development Kit', 'SendTokenResponse', 'BetaSendTokenResponse'] +--- + +# SendTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The token request ID | [optional] +**status** | **Enum** [ 'SUCCESS', 'FAILED' ] | Status of sending token | [optional] +**error_message** | **str** | Error messages from token send request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.send_token_response import SendTokenResponse + +send_token_response = SendTokenResponse( +request_id='089899f13a8f4da7824996191587bab9', +status='SUCCESS', +error_message='Unable to sent text message' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..0d26114ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,67 @@ +--- +id: beta-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationDto', 'BetaServiceDeskIntegrationDto'] +slug: /tools/sdk/python/beta/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'BetaServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Service Desk integration's name. The name must be unique. | [required] +**description** | **str** | Service Desk integration's description. | [required] +**type** | **str** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to 'ServiceNowSDIM'] +**owner_ref** | [**OwnerDto**](owner-dto) | | [optional] +**cluster_ref** | [**SourceClusterDto**](source-cluster-dto) | | [optional] +**cluster** | **str** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**managed_sources** | **[]str** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**provisioning_config** | [**ProvisioningConfig**](provisioning-config) | | [optional] +**attributes** | **map[string]object** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**before_provisioning_rule** | [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto + +service_desk_integration_dto = ServiceDeskIntegrationDto( +name='Service Desk Integration Name', +description='A very nice Service Desk integration', +type='ServiceNowSDIM', +owner_ref=sailpoint.beta.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +cluster_ref=sailpoint.beta.models.source_cluster_dto.SourceClusterDto( + type = 'CLUSTER', + id = '2c9180847a7fccdd017aa5896f9f4f6f', + name = 'Training VA', ), +cluster='xyzzy999', +managed_sources=[2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823], +provisioning_config=sailpoint.beta.models.provisioning_config.ProvisioningConfig( + universal_manager = True, + managed_resource_refs = [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], + plan_initializer_script = sailpoint.beta.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), + no_provisioning_requests = True, + provisioning_request_expiration = 7, ), +attributes={property=value, key=value}, +before_provisioning_rule=sailpoint.beta.models.before_provisioning_rule_dto.BeforeProvisioningRuleDto( + type = 'RULE', + id = '048eb3d55c5a4758bd07dccb87741c78', + name = 'Before Provisioning Airtable Rule', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..1e62e3008 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,52 @@ +--- +id: beta-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'BetaServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/python/beta/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'BetaServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**type** | **str** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to 'Web Service SDIM'] +**attributes** | **map[string]object** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] +**provisioning_config** | [**ProvisioningConfig**](provisioning-config) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + +service_desk_integration_template_dto = ServiceDeskIntegrationTemplateDto( +id='id12345', +name='aName', +created='2023-01-03T21:16:22.432Z', +modified='2023-01-03T21:16:22.432Z', +type='Web Service SDIM', +attributes={ }, +provisioning_config=sailpoint.beta.models.provisioning_config.ProvisioningConfig( + universal_manager = True, + managed_resource_refs = [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], + plan_initializer_script = sailpoint.beta.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), + no_provisioning_requests = True, + provisioning_request_expiration = 7, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..e483c73b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,38 @@ +--- +id: beta-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationTemplateType', 'BetaServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/python/beta/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'BetaServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +This represents a Service Desk Integration template type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This is the name of the type. | [optional] +**type** | **str** | This is the type value for the type. | [required] +**script_name** | **str** | This is the scriptName attribute value for the type. | [required] +} + +## Example + +```python +from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + +service_desk_integration_template_type = ServiceDeskIntegrationTemplateType( +name='aName', +type='aType', +script_name='aScriptName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskSource.md b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskSource.md new file mode 100644 index 000000000..f03fcd5c1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ServiceDeskSource.md @@ -0,0 +1,38 @@ +--- +id: beta-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskSource', 'BetaServiceDeskSource'] +slug: /tools/sdk/python/beta/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'BetaServiceDeskSource'] +--- + +# ServiceDeskSource + +Source for Service Desk integration template. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | DTO type of source for service desk integration template. | [optional] +**id** | **str** | ID of source for service desk integration template. | [optional] +**name** | **str** | Human-readable name of source for service desk integration template. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.service_desk_source import ServiceDeskSource + +service_desk_source = ServiceDeskSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SetIcon200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/SetIcon200Response.md new file mode 100644 index 000000000..745488b0e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SetIcon200Response.md @@ -0,0 +1,33 @@ +--- +id: beta-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetIcon200Response', 'BetaSetIcon200Response'] +slug: /tools/sdk/python/beta/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'BetaSetIcon200Response'] +--- + +# SetIcon200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**icon** | **str** | url to file with icon | [optional] +} + +## Example + +```python +from sailpoint.beta.models.set_icon200_response import SetIcon200Response + +set_icon200_response = SetIcon200Response( +icon='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SetIconRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SetIconRequest.md new file mode 100644 index 000000000..0c46ed90d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SetIconRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetIconRequest', 'BetaSetIconRequest'] +slug: /tools/sdk/python/beta/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'BetaSetIconRequest'] +--- + +# SetIconRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image** | **bytearray** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | [required] +} + +## Example + +```python +from sailpoint.beta.models.set_icon_request import SetIconRequest + +set_icon_request = SetIconRequest( +image='\x00\x00\x00\x02' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SimIntegrationDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..97b6286cf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SimIntegrationDetails.md @@ -0,0 +1,58 @@ +--- +id: beta-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SimIntegrationDetails', 'BetaSimIntegrationDetails'] +slug: /tools/sdk/python/beta/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'BetaSimIntegrationDetails'] +--- + +# SimIntegrationDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | The description of the integration | [optional] +**type** | **str** | The integration type | [optional] +**attributes** | **object** | The attributes map containing the credentials used to configure the integration. | [optional] +**sources** | **[]str** | The list of sources (managed resources) | [optional] +**cluster** | **str** | The cluster/proxy | [optional] +**status_map** | **object** | Custom mapping between the integration result and the provisioning result | [optional] +**request** | **object** | Request data to customize desc and body of the created ticket | [optional] +**before_provisioning_rule** | [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sim_integration_details import SimIntegrationDetails + +sim_integration_details = SimIntegrationDetails( +id='id12345', +name='aName', +created='2023-01-03T21:16:22.432Z', +modified='2023-01-03T21:16:22.432Z', +description='Integration description', +type='ServiceNow Service Desk', +attributes={"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"}, +sources=[2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823], +cluster='xyzzy999', +status_map={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}, +before_provisioning_rule=sailpoint.beta.models.sim_integration_details_all_of_before_provisioning_rule.SimIntegrationDetails_allOf_beforeProvisioningRule( + type = 'IDENTITY', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/python/Reference/Beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..8b4c3f4d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,38 @@ +--- +id: beta-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'BetaSimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/python/beta/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'BetaSimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +Before provisioning rule of integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | ID of the rule | [optional] +**name** | **str** | Human-readable display name of the rule | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sim_integration_details_all_of_before_provisioning_rule import SimIntegrationDetailsAllOfBeforeProvisioningRule + +sim_integration_details_all_of_before_provisioning_rule = SimIntegrationDetailsAllOfBeforeProvisioningRule( +type='IDENTITY', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/python/Reference/Beta/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..1a19a4af7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SlimDiscoveredApplications.md @@ -0,0 +1,50 @@ +--- +id: beta-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SlimDiscoveredApplications', 'BetaSlimDiscoveredApplications'] +slug: /tools/sdk/python/beta/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'BetaSlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +Discovered applications + +## 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] +} + +## Example + +```python +from sailpoint.beta.models.slim_discovered_applications import SlimDiscoveredApplications + +slim_discovered_applications = SlimDiscoveredApplications( +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Slimcampaign.md b/docs/tools/sdk/python/Reference/Beta/Models/Slimcampaign.md new file mode 100644 index 000000000..c49577309 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Slimcampaign.md @@ -0,0 +1,68 @@ +--- +id: beta-slimcampaign +title: Slimcampaign +pagination_label: Slimcampaign +sidebar_label: Slimcampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Slimcampaign', 'BetaSlimcampaign'] +slug: /tools/sdk/python/beta/models/slimcampaign +tags: ['SDK', 'Software Development Kit', 'Slimcampaign', 'BetaSlimcampaign'] +--- + +# Slimcampaign + + +## 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] +} + +## Example + +```python +from sailpoint.beta.models.slimcampaign import Slimcampaign + +slimcampaign = Slimcampaign( +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.beta.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.beta.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/Beta/Models/SodExemptCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/SodExemptCriteria.md new file mode 100644 index 000000000..af4d87d36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodExemptCriteria.md @@ -0,0 +1,40 @@ +--- +id: beta-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodExemptCriteria', 'BetaSodExemptCriteria'] +slug: /tools/sdk/python/beta/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'BetaSodExemptCriteria'] +--- + +# SodExemptCriteria + +Details of the Entitlement criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**existing** | **bool** | If the entitlement already belonged to the user or not. | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Entitlement ID | [optional] +**name** | **str** | Entitlement name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_exempt_criteria import SodExemptCriteria + +sod_exempt_criteria = SodExemptCriteria( +existing=True, +type='IDENTITY', +id='2c918085771e9d3301773b3cb66f6398', +name='My HR Entitlement' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodExemptCriteria1.md b/docs/tools/sdk/python/Reference/Beta/Models/SodExemptCriteria1.md new file mode 100644 index 000000000..9fb75f34f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodExemptCriteria1.md @@ -0,0 +1,40 @@ +--- +id: beta-sod-exempt-criteria1 +title: SodExemptCriteria1 +pagination_label: SodExemptCriteria1 +sidebar_label: SodExemptCriteria1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodExemptCriteria1', 'BetaSodExemptCriteria1'] +slug: /tools/sdk/python/beta/models/sod-exempt-criteria1 +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria1', 'BetaSodExemptCriteria1'] +--- + +# SodExemptCriteria1 + +Details of the Entitlement criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**existing** | **bool** | If the entitlement already belonged to the user or not. | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Entitlement ID | [optional] +**name** | **str** | Entitlement name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_exempt_criteria1 import SodExemptCriteria1 + +sod_exempt_criteria1 = SodExemptCriteria1( +existing=True, +type='IDENTITY', +id='2c918085771e9d3301773b3cb66f6398', +name='My HR Entitlement' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodPolicy.md b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicy.md new file mode 100644 index 000000000..424d5c723 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicy.md @@ -0,0 +1,75 @@ +--- +id: beta-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicy', 'BetaSodPolicy'] +slug: /tools/sdk/python/beta/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'BetaSodPolicy'] +--- + +# SodPolicy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Policy ID. | [optional] [readonly] +**name** | **str** | Policy business name. | [optional] +**created** | **datetime** | The time when this SOD policy is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy is modified. | [optional] [readonly] +**description** | **str** | Optional description of the SOD policy. | [optional] +**owner_ref** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**external_policy_reference** | **str** | Optional external policy reference. | [optional] +**policy_query** | **str** | Search query of the SOD policy. | [optional] +**compensating_controls** | **str** | Optional compensating controls (Mitigating Controls). | [optional] +**correction_advice** | **str** | Optional correction advice. | [optional] +**state** | **Enum** [ 'ENFORCED', 'NOT_ENFORCED' ] | Whether the policy is enforced or not. | [optional] +**tags** | **[]str** | Tags for the policy object. | [optional] +**creator_id** | **str** | Policy's creator ID. | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID. | [optional] [readonly] +**violation_owner_assignment_config** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**scheduled** | **bool** | Defines whether a policy has been scheduled or not. | [optional] [default to False] +**type** | **Enum** [ 'GENERAL', 'CONFLICTING_ACCESS_BASED' ] | Whether a policy is query based or conflicting access based. | [optional] [default to 'GENERAL'] +**conflicting_access_criteria** | [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_policy import SodPolicy + +sod_policy = SodPolicy( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='policy-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This policy ensures compliance of xyz', +owner_ref=sailpoint.beta.models.sod_policy_owner_ref.SodPolicy_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +external_policy_reference='XYZ policy', +policy_query='@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)', +compensating_controls='Have a manager review the transaction decisions for their "out of compliance" employee', +correction_advice='Based on the role of the employee, managers should remove access that is not required for their job function.', +state='ENFORCED', +tags=[TAG1, TAG2], +creator_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +modifier_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +violation_owner_assignment_config=sailpoint.beta.models.violation_owner_assignment_config.ViolationOwnerAssignmentConfig( + assignment_rule = 'MANAGER', + owner_ref = sailpoint.beta.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), ), +scheduled=True, +type='GENERAL', +conflicting_access_criteria= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..028b2ab99 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyConflictingAccessCriteria', 'BetaSodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/python/beta/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'BetaSodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +**right_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_policy_conflicting_access_criteria import SodPolicyConflictingAccessCriteria + +sod_policy_conflicting_access_criteria = SodPolicyConflictingAccessCriteria( +left_criteria=sailpoint.beta.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.beta.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyDto.md new file mode 100644 index 000000000..1c360408d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyDto.md @@ -0,0 +1,38 @@ +--- +id: beta-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyDto', 'BetaSodPolicyDto'] +slug: /tools/sdk/python/beta/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'BetaSodPolicyDto'] +--- + +# SodPolicyDto + +SOD policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOD_POLICY' ] | SOD policy DTO type. | [optional] +**id** | **str** | SOD policy ID. | [optional] +**name** | **str** | SOD policy display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_policy_dto import SodPolicyDto + +sod_policy_dto = SodPolicyDto( +type='SOD_POLICY', +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='Business SOD Policy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..a1b9c3a54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicyOwnerRef.md @@ -0,0 +1,38 @@ +--- +id: beta-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyOwnerRef', 'BetaSodPolicyOwnerRef'] +slug: /tools/sdk/python/beta/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'BetaSodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +The owner of the SOD policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | Owner type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_policy_owner_ref import SodPolicyOwnerRef + +sod_policy_owner_ref = SodPolicyOwnerRef( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodPolicySchedule.md b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicySchedule.md new file mode 100644 index 000000000..6e8b9d74c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodPolicySchedule.md @@ -0,0 +1,60 @@ +--- +id: beta-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicySchedule', 'BetaSodPolicySchedule'] +slug: /tools/sdk/python/beta/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'BetaSodPolicySchedule'] +--- + +# SodPolicySchedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | SOD Policy schedule name | [optional] +**created** | **datetime** | The time when this SOD policy schedule is created. | [optional] +**modified** | **datetime** | The time when this SOD policy schedule is modified. | [optional] +**description** | **str** | SOD Policy schedule description | [optional] +**schedule** | [**Schedule1**](schedule1) | | [optional] +**recipients** | [**[]SodRecipient**](sod-recipient) | | [optional] +**email_empty_results** | **bool** | Indicates if empty results need to be emailed | [optional] +**creator_id** | **str** | Policy's creator ID | [optional] +**modifier_id** | **str** | Policy's modifier ID | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule + +sod_policy_schedule = SodPolicySchedule( +name='SCH-1584312283015', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='Schedule for policy xyz', +schedule=sailpoint.beta.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.beta.models.sod_recipient.SodRecipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ) + ], +email_empty_results=False, +creator_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +modifier_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodRecipient.md b/docs/tools/sdk/python/Reference/Beta/Models/SodRecipient.md new file mode 100644 index 000000000..a2e49f3eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodRecipient.md @@ -0,0 +1,38 @@ +--- +id: beta-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodRecipient', 'BetaSodRecipient'] +slug: /tools/sdk/python/beta/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'BetaSodRecipient'] +--- + +# SodRecipient + +SOD policy recipient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | SOD policy recipient DTO type. | [optional] +**id** | **str** | SOD policy recipient's identity ID. | [optional] +**name** | **str** | SOD policy recipient's display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_recipient import SodRecipient + +sod_recipient = SodRecipient( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodReportResultDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SodReportResultDto.md new file mode 100644 index 000000000..c315974d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodReportResultDto.md @@ -0,0 +1,38 @@ +--- +id: beta-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodReportResultDto', 'BetaSodReportResultDto'] +slug: /tools/sdk/python/beta/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'BetaSodReportResultDto'] +--- + +# SodReportResultDto + +SOD policy violation report result. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_report_result_dto import SodReportResultDto + +sod_report_result_dto = SodReportResultDto( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationCheckResult.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..3f9b2a1ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationCheckResult.md @@ -0,0 +1,64 @@ +--- +id: beta-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationCheckResult', 'BetaSodViolationCheckResult'] +slug: /tools/sdk/python/beta/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'BetaSodViolationCheckResult'] +--- + +# SodViolationCheckResult + +The inner object representing the completed SOD Violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | [**ErrorMessageDto**](error-message-dto) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**violation_contexts** | [**[]SodViolationContext**](sod-violation-context) | | [optional] +**violated_policies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_check_result import SodViolationCheckResult + +sod_violation_check_result = SodViolationCheckResult( +message=sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +violation_contexts=[ + sailpoint.beta.models.sod_violation_context.SodViolationContext( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], +violated_policies=[ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationCheckResult1.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationCheckResult1.md new file mode 100644 index 000000000..8e6473b18 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationCheckResult1.md @@ -0,0 +1,64 @@ +--- +id: beta-sod-violation-check-result1 +title: SodViolationCheckResult1 +pagination_label: SodViolationCheckResult1 +sidebar_label: SodViolationCheckResult1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationCheckResult1', 'BetaSodViolationCheckResult1'] +slug: /tools/sdk/python/beta/models/sod-violation-check-result1 +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult1', 'BetaSodViolationCheckResult1'] +--- + +# SodViolationCheckResult1 + +The inner object representing the completed SOD Violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | [**ErrorMessageDto**](error-message-dto) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**violation_contexts** | [**[]SodViolationContext1**](sod-violation-context1) | | [optional] +**violated_policies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the Policies that were violated. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_check_result1 import SodViolationCheckResult1 + +sod_violation_check_result1 = SodViolationCheckResult1( +message=sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +violation_contexts=[ + sailpoint.beta.models.sod_violation_context_1.SodViolationContext_1( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ), ) + ], +violated_policies=[ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext.md new file mode 100644 index 000000000..02e4000be --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext.md @@ -0,0 +1,48 @@ +--- +id: beta-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContext', 'BetaSodViolationContext'] +slug: /tools/sdk/python/beta/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'BetaSodViolationContext'] +--- + +# SodViolationContext + +The contextual information of the violated criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**SodPolicyDto**](sod-policy-dto) | | [optional] +**conflicting_access_criteria** | [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context import SodViolationContext + +sod_violation_context = SodViolationContext( +policy=sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), +conflicting_access_criteria=sailpoint.beta.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1.md new file mode 100644 index 000000000..127fea089 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1.md @@ -0,0 +1,48 @@ +--- +id: beta-sod-violation-context1 +title: SodViolationContext1 +pagination_label: SodViolationContext1 +sidebar_label: SodViolationContext1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContext1', 'BetaSodViolationContext1'] +slug: /tools/sdk/python/beta/models/sod-violation-context1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1', 'BetaSodViolationContext1'] +--- + +# SodViolationContext1 + +The contextual information of the violated criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**SodPolicyDto**](sod-policy-dto) | | [optional] +**conflicting_access_criteria** | [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context1 import SodViolationContext1 + +sod_violation_context1 = SodViolationContext1( +policy=sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), +conflicting_access_criteria=sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteria.md new file mode 100644 index 000000000..249c91971 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteria.md @@ -0,0 +1,50 @@ +--- +id: beta-sod-violation-context1-conflicting-access-criteria +title: SodViolationContext1ConflictingAccessCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContext1ConflictingAccessCriteria', 'BetaSodViolationContext1ConflictingAccessCriteria'] +slug: /tools/sdk/python/beta/models/sod-violation-context1-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteria', 'BetaSodViolationContext1ConflictingAccessCriteria'] +--- + +# SodViolationContext1ConflictingAccessCriteria + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] +**right_criteria** | [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context1_conflicting_access_criteria import SodViolationContext1ConflictingAccessCriteria + +sod_violation_context1_conflicting_access_criteria = SodViolationContext1ConflictingAccessCriteria( +left_criteria=sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), +right_criteria=sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..52690f1b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-violation-context1-conflicting-access-criteria-left-criteria +title: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/python/beta/models/sod-violation-context1-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContext1ConflictingAccessCriteriaLeftCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteria_list** | [**[]SodExemptCriteria1**](sod-exempt-criteria1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context1_conflicting_access_criteria_left_criteria import SodViolationContext1ConflictingAccessCriteriaLeftCriteria + +sod_violation_context1_conflicting_access_criteria_left_criteria = SodViolationContext1ConflictingAccessCriteriaLeftCriteria( +criteria_list=[ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..296b955f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,65 @@ +--- +id: beta-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextCheckCompleted', 'BetaSodViolationContextCheckCompleted'] +slug: /tools/sdk/python/beta/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'BetaSodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +An object referencing a completed SOD violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context_check_completed import SodViolationContextCheckCompleted + +sod_violation_context_check_completed = SodViolationContextCheckCompleted( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.beta.models.sod_violation_check_result.SodViolationCheckResult( + message = sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.beta.models.sod_violation_context.SodViolationContext( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextCheckCompleted1.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextCheckCompleted1.md new file mode 100644 index 000000000..8006b5344 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextCheckCompleted1.md @@ -0,0 +1,65 @@ +--- +id: beta-sod-violation-context-check-completed1 +title: SodViolationContextCheckCompleted1 +pagination_label: SodViolationContextCheckCompleted1 +sidebar_label: SodViolationContextCheckCompleted1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextCheckCompleted1', 'BetaSodViolationContextCheckCompleted1'] +slug: /tools/sdk/python/beta/models/sod-violation-context-check-completed1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted1', 'BetaSodViolationContextCheckCompleted1'] +--- + +# SodViolationContextCheckCompleted1 + +An object referencing a completed SOD violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context_check_completed1 import SodViolationContextCheckCompleted1 + +sod_violation_context_check_completed1 = SodViolationContextCheckCompleted1( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.beta.models.sod_violation_check_result_1.SodViolationCheckResult_1( + message = sailpoint.beta.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.beta.models.sod_violation_context_1.SodViolationContext_1( + policy = sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria( + left_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria_1.SodExemptCriteria_1( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.beta.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.beta.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..7ec0f399b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,50 @@ +--- +id: beta-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'BetaSodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/python/beta/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'BetaSodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**right_criteria** | [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context_conflicting_access_criteria import SodViolationContextConflictingAccessCriteria + +sod_violation_context_conflicting_access_criteria = SodViolationContextConflictingAccessCriteria( +left_criteria=sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), +right_criteria=sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..74df1be53 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/python/beta/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteria_list** | [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sod_violation_context_conflicting_access_criteria_left_criteria import SodViolationContextConflictingAccessCriteriaLeftCriteria + +sod_violation_context_conflicting_access_criteria_left_criteria = SodViolationContextConflictingAccessCriteriaLeftCriteria( +criteria_list=[ + sailpoint.beta.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Source.md b/docs/tools/sdk/python/Reference/Beta/Models/Source.md new file mode 100644 index 000000000..6e2980386 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Source.md @@ -0,0 +1,116 @@ +--- +id: beta-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source', 'BetaSource'] +slug: /tools/sdk/python/beta/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'BetaSource'] +--- + +# Source + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Source ID. | [optional] [readonly] +**name** | **str** | Source's human-readable name. | [required] +**description** | **str** | Source's human-readable description. | [optional] +**owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**cluster** | [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**account_correlation_config** | [**MultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] +**account_correlation_rule** | [**MultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] +**manager_correlation_mapping** | [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**manager_correlation_rule** | [**MultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] +**before_provisioning_rule** | [**MultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] +**schemas** | [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] +**password_policies** | [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**type** | **str** | 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`. | [optional] +**connector** | **str** | Connector script name. | [required] +**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**connector_attributes** | **object** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False] +**management_workgroup** | [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**since** | **str** | Timestamp that shows when a source health check was last performed. | [optional] +**connector_id** | **str** | Connector ID | [optional] +**connector_name** | **str** | Name of the connector that was chosen during source creation. | [optional] +**connection_type** | **str** | Type of connection (direct or file). | [optional] +**connector_implementation_id** | **str** | Connector implementation ID. | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False] +**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source import Source + +source = Source( +id='2c91808568c529c60168cca6f90c1324', +name='My Source', +description='This is the corporate directory.', +owner=sailpoint.beta.models.multi_host_integrations_owner.MultiHostIntegrations_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'MyName', ), +cluster=sailpoint.beta.models.multi_host_integrations_cluster.MultiHostIntegrations_cluster( + type = 'CLUSTER', + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Corporate Cluster', ), +account_correlation_config=sailpoint.beta.models.multi_host_sources_account_correlation_config.MultiHostSources_accountCorrelationConfig( + type = 'ACCOUNT_CORRELATION_CONFIG', + id = '2c9180855d191c59015d28583727245a', + name = 'Directory [source-62867] Account Correlation', ), +account_correlation_rule=sailpoint.beta.models.multi_host_sources_account_correlation_rule.MultiHostSources_accountCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +manager_correlation_mapping=sailpoint.beta.models.manager_correlation_mapping.ManagerCorrelationMapping( + account_attribute_name = 'manager', + identity_attribute_name = 'manager', ), +manager_correlation_rule=sailpoint.beta.models.multi_host_sources_manager_correlation_rule.MultiHostSources_managerCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +before_provisioning_rule=sailpoint.beta.models.multi_host_sources_before_provisioning_rule.MultiHostSources_beforeProvisioningRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}], +password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}], +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +type='OpenLDAP - Direct', +connector='active-directory', +connector_class='sailpoint.connector.LDAPConnector', +connector_attributes={healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]}, +delete_threshold=10, +authoritative=False, +management_workgroup=sailpoint.beta.models.multi_host_integrations_management_workgroup.MultiHostIntegrations_managementWorkgroup( + type = 'GOVERNANCE_GROUP', + id = '2c91808568c529c60168cca6f90c2222', + name = 'My Management Workgroup', ), +healthy=True, +status='SOURCE_STATE_HEALTHY', +since='2021-09-28T15:48:29.3801666300Z', +connector_id='active-directory', +connector_name='Active Directory', +connection_type='file', +connector_implementation_id='delimited-file', +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z', +credential_provider_enabled=False, +category='CredentialProvider' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Source1.md b/docs/tools/sdk/python/Reference/Beta/Models/Source1.md new file mode 100644 index 000000000..de3bf52a2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Source1.md @@ -0,0 +1,35 @@ +--- +id: beta-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source1', 'BetaSource1'] +slug: /tools/sdk/python/beta/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'BetaSource1'] +--- + +# Source1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Attribute mapping type. | [optional] +**properties** | **object** | Attribute mapping properties. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source1 import Source1 + +source1 = Source1( +type='rule', +properties={ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountCreated.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountCreated.md new file mode 100644 index 000000000..1b1febf4c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountCreated.md @@ -0,0 +1,47 @@ +--- +id: beta-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountCreated', 'BetaSourceAccountCreated'] +slug: /tools/sdk/python/beta/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'BetaSourceAccountCreated'] +--- + +# SourceAccountCreated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | SailPoint generated unique identifier. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_account_created import SourceAccountCreated + +source_account_created = SourceAccountCreated( +uuid='b7264868-7201-415f-9118-b581d431c688', +id='ee769173319b41d19ccec35ba52f237b', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +attributes={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountDeleted.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..7f70eeeaf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountDeleted.md @@ -0,0 +1,47 @@ +--- +id: beta-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountDeleted', 'BetaSourceAccountDeleted'] +slug: /tools/sdk/python/beta/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'BetaSourceAccountDeleted'] +--- + +# SourceAccountDeleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | SailPoint generated unique identifier. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_account_deleted import SourceAccountDeleted + +source_account_deleted = SourceAccountDeleted( +uuid='b7264868-7201-415f-9118-b581d431c688', +id='ee769173319b41d19ccec35ba52f237b', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +attributes={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountUpdated.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..5ebd7a8ca --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAccountUpdated.md @@ -0,0 +1,47 @@ +--- +id: beta-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountUpdated', 'BetaSourceAccountUpdated'] +slug: /tools/sdk/python/beta/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'BetaSourceAccountUpdated'] +--- + +# SourceAccountUpdated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | SailPoint generated unique identifier. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_account_updated import SourceAccountUpdated + +source_account_updated = SourceAccountUpdated( +uuid='b7264868-7201-415f-9118-b581d431c688', +id='ee769173319b41d19ccec35ba52f237b', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +attributes={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceApp.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceApp.md new file mode 100644 index 000000000..be360472a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceApp.md @@ -0,0 +1,63 @@ +--- +id: beta-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceApp', 'BetaSourceApp'] +slug: /tools/sdk/python/beta/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'BetaSourceApp'] +--- + +# SourceApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source app id | [optional] +**cloud_app_id** | **str** | The deprecated source app id | [optional] +**name** | **str** | The source app name | [optional] +**created** | **datetime** | Time when the source app was created | [optional] +**modified** | **datetime** | Time when the source app was last modified | [optional] +**enabled** | **bool** | True if the source app is enabled | [optional] [default to False] +**provision_request_enabled** | **bool** | True if the source app is provision request enabled | [optional] [default to False] +**description** | **str** | The description of the source app | [optional] +**match_all_accounts** | **bool** | True if the source app match all accounts | [optional] [default to False] +**app_center_enabled** | **bool** | True if the source app is shown in the app center | [optional] [default to True] +**account_source** | [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**owner** | [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_app import SourceApp + +source_app = SourceApp( +id='2c91808874ff91550175097daaec161c', +cloud_app_id='9854520', +name='my app', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +enabled=True, +provision_request_enabled=True, +description='the source app for engineers', +match_all_accounts=True, +app_center_enabled=True, +account_source=sailpoint.beta.models.source_app_account_source.SourceApp_accountSource( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', + use_for_password_management = False, + password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ), +owner=sailpoint.beta.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAppAccountSource.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..df0f271b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppAccountSource.md @@ -0,0 +1,41 @@ +--- +id: beta-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppAccountSource', 'BetaSourceAppAccountSource'] +slug: /tools/sdk/python/beta/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'BetaSourceAppAccountSource'] +--- + +# SourceAppAccountSource + + +## 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] +**use_for_password_management** | **bool** | If the source is used for password management | [optional] [default to False] +**password_policies** | [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_app_account_source import SourceAppAccountSource + +source_app_account_source = SourceAppAccountSource( +id='2c9180827ca885d7017ca8ce28a000eb', +type='SOURCE', +name='ODS-AD-Source', +use_for_password_management=False, +password_policies=[{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..0e4ce6903 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppBulkUpdateRequest', 'BetaSourceAppBulkUpdateRequest'] +slug: /tools/sdk/python/beta/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'BetaSourceAppBulkUpdateRequest'] +--- + +# SourceAppBulkUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_ids** | **[]str** | List of source app ids to update | [required] +**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest + +source_app_bulk_update_request = SourceAppBulkUpdateRequest( +app_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f], +json_patch=[{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAppCreateDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..67fc77e72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppCreateDto.md @@ -0,0 +1,42 @@ +--- +id: beta-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppCreateDto', 'BetaSourceAppCreateDto'] +slug: /tools/sdk/python/beta/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'BetaSourceAppCreateDto'] +--- + +# SourceAppCreateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The source app name | [required] +**description** | **str** | The description of the source app | [required] +**match_all_accounts** | **bool** | True if the source app match all accounts | [optional] [default to False] +**account_source** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_app_create_dto import SourceAppCreateDto + +source_app_create_dto = SourceAppCreateDto( +name='my app', +description='the source app for engineers', +match_all_accounts=True, +account_source=sailpoint.beta.models.source_app_create_dto_account_source.SourceAppCreateDto_accountSource( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..d9ac839f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,37 @@ +--- +id: beta-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppCreateDtoAccountSource', 'BetaSourceAppCreateDtoAccountSource'] +slug: /tools/sdk/python/beta/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'BetaSourceAppCreateDtoAccountSource'] +--- + +# SourceAppCreateDtoAccountSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source ID | [required] +**type** | **str** | The source type, will always be \"SOURCE\" | [optional] +**name** | **str** | The source name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_app_create_dto_account_source import SourceAppCreateDtoAccountSource + +source_app_create_dto_account_source = SourceAppCreateDtoAccountSource( +id='2c9180827ca885d7017ca8ce28a000eb', +type='SOURCE', +name='ODS-AD-Source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceAppPatchDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..1f9d2e169 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceAppPatchDto.md @@ -0,0 +1,65 @@ +--- +id: beta-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppPatchDto', 'BetaSourceAppPatchDto'] +slug: /tools/sdk/python/beta/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'BetaSourceAppPatchDto'] +--- + +# SourceAppPatchDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source app id | [optional] +**cloud_app_id** | **str** | The deprecated source app id | [optional] +**name** | **str** | The source app name | [optional] +**created** | **datetime** | Time when the source app was created | [optional] +**modified** | **datetime** | Time when the source app was last modified | [optional] +**enabled** | **bool** | True if the source app is enabled | [optional] [default to False] +**provision_request_enabled** | **bool** | True if the source app is provision request enabled | [optional] [default to False] +**description** | **str** | The description of the source app | [optional] +**match_all_accounts** | **bool** | True if the source app match all accounts | [optional] [default to False] +**app_center_enabled** | **bool** | True if the source app is shown in the app center | [optional] [default to True] +**access_profiles** | **[]str** | List of IDs of access profiles | [optional] +**account_source** | [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**owner** | [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_app_patch_dto import SourceAppPatchDto + +source_app_patch_dto = SourceAppPatchDto( +id='2c91808874ff91550175097daaec161c', +cloud_app_id='9854520', +name='my app', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +enabled=True, +provision_request_enabled=True, +description='the source app for engineers', +match_all_accounts=True, +app_center_enabled=True, +access_profiles=[2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9], +account_source=sailpoint.beta.models.source_app_account_source.SourceApp_accountSource( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', + use_for_password_management = False, + password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ), +owner=sailpoint.beta.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceClusterDto.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceClusterDto.md new file mode 100644 index 000000000..cb07e16aa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceClusterDto.md @@ -0,0 +1,38 @@ +--- +id: beta-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceClusterDto', 'BetaSourceClusterDto'] +slug: /tools/sdk/python/beta/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'BetaSourceClusterDto'] +--- + +# SourceClusterDto + +Source cluster. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CLUSTER' ] | Source cluster DTO type. | [optional] +**id** | **str** | Source cluster ID. | [optional] +**name** | **str** | Source cluster display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_cluster_dto import SourceClusterDto + +source_cluster_dto = SourceClusterDto( +type='CLUSTER', +id='2c9180847a7fccdd017aa5896f9f4f6f', +name='Training VA' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceCode.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceCode.md new file mode 100644 index 000000000..4afc0e4c5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceCode.md @@ -0,0 +1,36 @@ +--- +id: beta-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCode', 'BetaSourceCode'] +slug: /tools/sdk/python/beta/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'BetaSourceCode'] +--- + +# SourceCode + +SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **str** | the version of the code | [required] +**script** | **str** | The code | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_code import SourceCode + +source_code = SourceCode( +version='1.0', +script='return "Mr. " + firstName;' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceCreated.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceCreated.md new file mode 100644 index 000000000..5c7636da8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceCreated.md @@ -0,0 +1,46 @@ +--- +id: beta-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCreated', 'BetaSourceCreated'] +slug: /tools/sdk/python/beta/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'BetaSourceCreated'] +--- + +# SourceCreated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the source. | [required] +**name** | **str** | Human friendly name of the source. | [required] +**type** | **str** | The connection type. | [required] +**created** | **datetime** | The date and time the source was created. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceCreatedActor**](source-created-actor) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_created import SourceCreated + +source_created = SourceCreated( +id='2c9180866166b5b0016167c32ef31a66', +name='Test source', +type='DIRECT_CONNECT', +created='2021-03-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.beta.models.source_created_actor.SourceCreated_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceCreatedActor.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceCreatedActor.md new file mode 100644 index 000000000..34ac885b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceCreatedActor.md @@ -0,0 +1,38 @@ +--- +id: beta-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCreatedActor', 'BetaSourceCreatedActor'] +slug: /tools/sdk/python/beta/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'BetaSourceCreatedActor'] +--- + +# SourceCreatedActor + +Identity who created the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who created the source. | [required] +**id** | **str** | ID of identity who created the source. | [required] +**name** | **str** | Display name of identity who created the source. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_created_actor import SourceCreatedActor + +source_created_actor = SourceCreatedActor( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceCreationErrors.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceCreationErrors.md new file mode 100644 index 000000000..317383d87 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceCreationErrors.md @@ -0,0 +1,43 @@ +--- +id: beta-source-creation-errors +title: SourceCreationErrors +pagination_label: SourceCreationErrors +sidebar_label: SourceCreationErrors +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCreationErrors', 'BetaSourceCreationErrors'] +slug: /tools/sdk/python/beta/models/source-creation-errors +tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'BetaSourceCreationErrors'] +--- + +# SourceCreationErrors + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**multihost_id** | **str** | Multi-Host Integration ID. | [optional] [readonly] +**source_name** | **str** | Source's human-readable name. | [optional] +**source_error** | **str** | Source's human-readable description. | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +**operation** | **str** | operation category (e.g. DELETE). | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_creation_errors import SourceCreationErrors + +source_creation_errors = SourceCreationErrors( +multihost_id='2c91808568c529c60168cca6f90c1324', +source_name='My Source', +source_error='Source with internal name "My Source [source]" already exists.', +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z', +operation='DELETE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceDeleted.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceDeleted.md new file mode 100644 index 000000000..588a18e0a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceDeleted.md @@ -0,0 +1,46 @@ +--- +id: beta-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceDeleted', 'BetaSourceDeleted'] +slug: /tools/sdk/python/beta/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'BetaSourceDeleted'] +--- + +# SourceDeleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the source. | [required] +**name** | **str** | Human friendly name of the source. | [required] +**type** | **str** | The connection type. | [required] +**deleted** | **datetime** | The date and time the source was deleted. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_deleted import SourceDeleted + +source_deleted = SourceDeleted( +id='2c9180866166b5b0016167c32ef31a66', +name='Test source', +type='DIRECT_CONNECT', +deleted='2021-03-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.beta.models.source_deleted_actor.SourceDeleted_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceDeletedActor.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceDeletedActor.md new file mode 100644 index 000000000..56fefd19a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceDeletedActor.md @@ -0,0 +1,38 @@ +--- +id: beta-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceDeletedActor', 'BetaSourceDeletedActor'] +slug: /tools/sdk/python/beta/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'BetaSourceDeletedActor'] +--- + +# SourceDeletedActor + +Identity who deleted the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who deleted the source. | [required] +**id** | **str** | ID of identity who deleted the source. | [required] +**name** | **str** | Display name of identity who deleted the source. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_deleted_actor import SourceDeletedActor + +source_deleted_actor = SourceDeletedActor( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..4431edcdb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceEntitlementRequestConfig', 'BetaSourceEntitlementRequestConfig'] +slug: /tools/sdk/python/beta/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'BetaSourceEntitlementRequestConfig'] +--- + +# SourceEntitlementRequestConfig + +Entitlement Request Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_config** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_entitlement_request_config import SourceEntitlementRequestConfig + +source_entitlement_request_config = SourceEntitlementRequestConfig( +access_request_config=sailpoint.beta.models.entitlement_access_request_config.EntitlementAccessRequestConfig( + approval_schemes = [ + sailpoint.beta.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/Beta/Models/SourceSyncJob.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceSyncJob.md new file mode 100644 index 000000000..1467a8915 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceSyncJob.md @@ -0,0 +1,39 @@ +--- +id: beta-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSyncJob', 'BetaSourceSyncJob'] +slug: /tools/sdk/python/beta/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'BetaSourceSyncJob'] +--- + +# SourceSyncJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Job ID. | [required] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The job status. | [required] +**payload** | [**SourceSyncPayload**](source-sync-payload) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_sync_job import SourceSyncJob + +source_sync_job = SourceSyncJob( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +status='IN_PROGRESS', +payload=sailpoint.beta.models.source_sync_payload.SourceSyncPayload( + type = 'SYNCHRONIZE_SOURCE_ATTRIBUTES', + data_json = '{"sourceId":"2c918083746f642c01746f990884012a"}', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceSyncPayload.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceSyncPayload.md new file mode 100644 index 000000000..bd2928381 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceSyncPayload.md @@ -0,0 +1,35 @@ +--- +id: beta-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSyncPayload', 'BetaSourceSyncPayload'] +slug: /tools/sdk/python/beta/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'BetaSourceSyncPayload'] +--- + +# SourceSyncPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Payload type. | [required] +**data_json** | **str** | Payload type. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_sync_payload import SourceSyncPayload + +source_sync_payload = SourceSyncPayload( +type='SYNCHRONIZE_SOURCE_ATTRIBUTES', +data_json='{"sourceId":"2c918083746f642c01746f990884012a"}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUpdated.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUpdated.md new file mode 100644 index 000000000..7ae067fae --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUpdated.md @@ -0,0 +1,46 @@ +--- +id: beta-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUpdated', 'BetaSourceUpdated'] +slug: /tools/sdk/python/beta/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'BetaSourceUpdated'] +--- + +# SourceUpdated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the source. | [required] +**name** | **str** | The user friendly name of the source. | [required] +**type** | **str** | The connection type of the source. | [required] +**modified** | **datetime** | The date and time the source was modified. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_updated import SourceUpdated + +source_updated = SourceUpdated( +id='2c9180866166b5b0016167c32ef31a66', +name='Corporate Active Directory', +type='DIRECT_CONNECT', +modified='2021-03-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.beta.models.source_updated_actor.SourceUpdated_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUpdatedActor.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..00370184e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUpdatedActor.md @@ -0,0 +1,38 @@ +--- +id: beta-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUpdatedActor', 'BetaSourceUpdatedActor'] +slug: /tools/sdk/python/beta/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'BetaSourceUpdatedActor'] +--- + +# SourceUpdatedActor + +Identity who updated the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who updated the source. | [required] +**id** | **str** | ID of identity who updated the source. | [optional] +**name** | **str** | Display name of identity who updated the source. | [required] +} + +## Example + +```python +from sailpoint.beta.models.source_updated_actor import SourceUpdatedActor + +source_updated_actor = SourceUpdatedActor( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md new file mode 100644 index 000000000..72badf0ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md @@ -0,0 +1,35 @@ +--- +id: beta-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUsage', 'BetaSourceUsage'] +slug: /tools/sdk/python/beta/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'BetaSourceUsage'] +--- + +# SourceUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional] +**count** | **float** | The average number of days that accounts were active within this source, for the month. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_usage import SourceUsage + +source_usage = SourceUsage( +var_date='Thu Apr 20 20:00:00 EDT 2023', +count=10.45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceUsageStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsageStatus.md new file mode 100644 index 000000000..5973670c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceUsageStatus.md @@ -0,0 +1,33 @@ +--- +id: beta-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUsageStatus', 'BetaSourceUsageStatus'] +slug: /tools/sdk/python/beta/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'BetaSourceUsageStatus'] +--- + +# SourceUsageStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'COMPLETE', 'INCOMPLETE' ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_usage_status import SourceUsageStatus + +source_usage_status = SourceUsageStatus( +status='COMPLETE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportJob.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportJob.md new file mode 100644 index 000000000..7877990dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportJob.md @@ -0,0 +1,45 @@ +--- +id: beta-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigExportJob', 'BetaSpConfigExportJob'] +slug: /tools/sdk/python/beta/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'BetaSpConfigExportJob'] +--- + +# SpConfigExportJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +**description** | **str** | Optional user defined description/name for export job. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob + +sp_config_export_job = SpConfigExportJob( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +description='ETS configuration objects from Acme-Solar sandbox' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..fc57f078b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportJobStatus.md @@ -0,0 +1,47 @@ +--- +id: beta-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigExportJobStatus', 'BetaSpConfigExportJobStatus'] +slug: /tools/sdk/python/beta/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'BetaSpConfigExportJobStatus'] +--- + +# SpConfigExportJobStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +**description** | **str** | Optional user defined description/name for export job. | [optional] +**completed** | **datetime** | The time the job was completed. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus + +sp_config_export_job_status = SpConfigExportJobStatus( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +description='ETS configuration objects from Acme-Solar sandbox', +completed='2021-05-11T22:23:16Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportResults.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportResults.md new file mode 100644 index 000000000..3c14d5cc9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigExportResults.md @@ -0,0 +1,59 @@ +--- +id: beta-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigExportResults', 'BetaSpConfigExportResults'] +slug: /tools/sdk/python/beta/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'BetaSpConfigExportResults'] +--- + +# SpConfigExportResults + +Response model for config export download response. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Current version of the export results object. | [optional] +**timestamp** | **datetime** | Time the export was completed. | [optional] +**tenant** | **str** | Name of the tenant where this export originated. | [optional] +**description** | **str** | Optional user defined description/name for export job. | [optional] +**options** | [**ExportOptions**](export-options) | | [optional] +**objects** | [**[]ConfigObject**](config-object) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults + +sp_config_export_results = SpConfigExportResults( +version=1, +timestamp='2021-05-11T22:23:16Z', +tenant='sample-tenant', +description='Export Job 1 Test', +options=sailpoint.beta.models.export_options.ExportOptions( + exclude_types = [ + 'SOURCE' + ], + include_types = [ + 'TRIGGER_SUBSCRIPTION' + ], + object_options = {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}, ), +objects=[ + sailpoint.beta.models.config_object_for_export_and_import.Config Object for Export and Import( + version = 1, + self = sailpoint.beta.models.self_import_export_dto.SelfImportExportDto( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), + object = { }, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..c8ecd7d43 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigImportJobStatus.md @@ -0,0 +1,47 @@ +--- +id: beta-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigImportJobStatus', 'BetaSpConfigImportJobStatus'] +slug: /tools/sdk/python/beta/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'BetaSpConfigImportJobStatus'] +--- + +# SpConfigImportJobStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +**message** | **str** | This message contains additional information about the overall status of the job. | [optional] +**completed** | **datetime** | The time the job was completed. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus + +sp_config_import_job_status = SpConfigImportJobStatus( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +message='Download import results for details.', +completed='2021-05-11T22:23:16Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigImportResults.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigImportResults.md new file mode 100644 index 000000000..39328ce6f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigImportResults.md @@ -0,0 +1,36 @@ +--- +id: beta-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigImportResults', 'BetaSpConfigImportResults'] +slug: /tools/sdk/python/beta/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'BetaSpConfigImportResults'] +--- + +# SpConfigImportResults + +Response Body for Config Import command. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**map[string]ObjectImportResult**](object-import-result) | The results of an object configuration import job. | [required] +**export_job_id** | **str** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults + +sp_config_import_results = SpConfigImportResults( +results={results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}}, +export_job_id='be9e116d-08e1-49fc-ab7f-fa585e96c9e4' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigJob.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigJob.md new file mode 100644 index 000000000..bdcacf144 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigJob.md @@ -0,0 +1,43 @@ +--- +id: beta-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigJob', 'BetaSpConfigJob'] +slug: /tools/sdk/python/beta/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'BetaSpConfigJob'] +--- + +# SpConfigJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_job import SpConfigJob + +sp_config_job = SpConfigJob( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigMessage.md new file mode 100644 index 000000000..9adc98af9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigMessage.md @@ -0,0 +1,38 @@ +--- +id: beta-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigMessage', 'BetaSpConfigMessage'] +slug: /tools/sdk/python/beta/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'BetaSpConfigMessage'] +--- + +# SpConfigMessage + +Message model for Config Import/Export. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Message key. | [required] +**text** | **str** | Message text. | [required] +**details** | **map[string]object** | Message details if any, in key:value pairs. | [required] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_message import SpConfigMessage + +sp_config_message = SpConfigMessage( +key='UNKNOWN_REFERENCE_RESOLVER', +text='Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', +details={details=message details} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md new file mode 100644 index 000000000..fdc795f85 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md @@ -0,0 +1,60 @@ +--- +id: beta-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigObject', 'BetaSpConfigObject'] +slug: /tools/sdk/python/beta/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'BetaSpConfigObject'] +--- + +# SpConfigObject + +Response model for get object configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_type** | **str** | The object type this configuration is for. | [optional] +**reference_extractors** | **[]str** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] +**signature_required** | **bool** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False] +**always_resolve_by_id** | **bool** | Whether this object type has to be resolved always by ID | [optional] [default to False] +**legacy_object** | **bool** | Whether this is a legacy object | [optional] [default to False] +**one_per_tenant** | **bool** | Whether there is only one object of this type | [optional] [default to False] +**exportable** | **bool** | Whether this object can be exported or it is just a reference object | [optional] [default to False] +**rules** | [**SpConfigRules**](sp-config-rules) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_object import SpConfigObject + +sp_config_object = SpConfigObject( +object_type='TRIGGER_SUBSCRIPTION', +reference_extractors=[$.owner], +signature_required=False, +always_resolve_by_id=True, +legacy_object=False, +one_per_tenant=False, +exportable=True, +rules=sailpoint.beta.models.config_object_rules.Config Object Rules( + take_from_target_rules = [ + sailpoint.beta.models.config_object_rule.Config Object Rule( + path = '$.enabled', + value = null, + modes = [RESTORE, PROMOTE], ) + ], + default_rules = [ + sailpoint.beta.models.config_object_rule.Config Object Rule( + path = '$.enabled', + modes = [RESTORE, PROMOTE], ) + ], + editable = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md new file mode 100644 index 000000000..ac57569b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md @@ -0,0 +1,38 @@ +--- +id: beta-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigRule', 'BetaSpConfigRule'] +slug: /tools/sdk/python/beta/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] +--- + +# SpConfigRule + +Format of Config Hub Object Rules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] +**value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] +**modes** | **[]str** | Draft modes to which this rule will apply | [optional] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_rule import SpConfigRule + +sp_config_rule = SpConfigRule( +path='$.enabled', +value=, +modes=[RESTORE, PROMOTE] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md new file mode 100644 index 000000000..0700333f6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md @@ -0,0 +1,32 @@ +--- +id: beta-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] +slug: /tools/sdk/python/beta/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] +--- + +# SpConfigRuleValue + +Value to be assigned at the jsonPath location within the object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.sp_config_rule_value import SpConfigRuleValue + +sp_config_rule_value = SpConfigRuleValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md new file mode 100644 index 000000000..108de6f7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md @@ -0,0 +1,48 @@ +--- +id: beta-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigRules', 'BetaSpConfigRules'] +slug: /tools/sdk/python/beta/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'BetaSpConfigRules'] +--- + +# SpConfigRules + +Rules to be applied to the config object during draft process + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**take_from_target_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] +**default_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] +**editable** | **bool** | Whether this object can be edited | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.sp_config_rules import SpConfigRules + +sp_config_rules = SpConfigRules( +take_from_target_rules=[ + sailpoint.beta.models.config_object_rule.Config Object Rule( + path = '$.enabled', + value = null, + modes = [RESTORE, PROMOTE], ) + ], +default_rules=[ + sailpoint.beta.models.config_object_rule.Config Object Rule( + path = '$.enabled', + value = null, + modes = [RESTORE, PROMOTE], ) + ], +editable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/StandardLevel.md b/docs/tools/sdk/python/Reference/Beta/Models/StandardLevel.md new file mode 100644 index 000000000..f37958963 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/StandardLevel.md @@ -0,0 +1,33 @@ +--- +id: beta-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StandardLevel', 'BetaStandardLevel'] +slug: /tools/sdk/python/beta/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'BetaStandardLevel'] +--- + +# StandardLevel + +Standard Log4j log level + +## Enum + +* `FALSE` (value: `'false'`) + +* `FATAL` (value: `'FATAL'`) + +* `ERROR` (value: `'ERROR'`) + +* `WARN` (value: `'WARN'`) + +* `INFO` (value: `'INFO'`) + +* `DEBUG` (value: `'DEBUG'`) + +* `TRACE` (value: `'TRACE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/StartInvocationInput.md b/docs/tools/sdk/python/Reference/Beta/Models/StartInvocationInput.md new file mode 100644 index 000000000..2da489ecb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/StartInvocationInput.md @@ -0,0 +1,37 @@ +--- +id: beta-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StartInvocationInput', 'BetaStartInvocationInput'] +slug: /tools/sdk/python/beta/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'BetaStartInvocationInput'] +--- + +# StartInvocationInput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trigger_id** | **str** | Trigger ID | [optional] +**input** | **object** | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**content_json** | **object** | JSON map of invocation metadata | [optional] +} + +## Example + +```python +from sailpoint.beta.models.start_invocation_input import StartInvocationInput + +start_invocation_input = StartInvocationInput( +trigger_id='idn:access-requested', +input={identityId=201327fda1c44704ac01181e963d463c}, +content_json={workflowId=1234} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/StartLauncher200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/StartLauncher200Response.md new file mode 100644 index 000000000..d6b827a16 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/StartLauncher200Response.md @@ -0,0 +1,33 @@ +--- +id: beta-start-launcher200-response +title: StartLauncher200Response +pagination_label: StartLauncher200Response +sidebar_label: StartLauncher200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StartLauncher200Response', 'BetaStartLauncher200Response'] +slug: /tools/sdk/python/beta/models/start-launcher200-response +tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'BetaStartLauncher200Response'] +--- + +# StartLauncher200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**interactive_process_id** | **str** | ID of the Interactive Process that was launched | [required] +} + +## Example + +```python +from sailpoint.beta.models.start_launcher200_response import StartLauncher200Response + +start_launcher200_response = StartLauncher200Response( +interactive_process_id='5da68cfe-2d60-4b09-858f-0d03acd2f47a' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/StatusResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/StatusResponse.md new file mode 100644 index 000000000..0bd9cc163 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/StatusResponse.md @@ -0,0 +1,42 @@ +--- +id: beta-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StatusResponse', 'BetaStatusResponse'] +slug: /tools/sdk/python/beta/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'BetaStatusResponse'] +--- + +# StatusResponse + +Response model for connection check, configuration test and ping of source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the source | [optional] [readonly] +**name** | **str** | Name of the source | [optional] [readonly] +**status** | **Enum** [ 'SUCCESS', 'FAILURE' ] | The status of the health check. | [optional] [readonly] +**elapsed_millis** | **int** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**details** | **object** | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.status_response import StatusResponse + +status_response = StatusResponse( +id='2c91808568c529c60168cca6f90c1313', +name='ODS-AD-Test [source-999999]', +status='SUCCESS', +elapsed_millis=1000, +details={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Subscription.md b/docs/tools/sdk/python/Reference/Beta/Models/Subscription.md new file mode 100644 index 000000000..0c1f93b72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Subscription.md @@ -0,0 +1,63 @@ +--- +id: beta-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Subscription', 'BetaSubscription'] +slug: /tools/sdk/python/beta/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'BetaSubscription'] +--- + +# Subscription + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Subscription ID. | [required] +**name** | **str** | Subscription name. | [required] +**description** | **str** | Subscription description. | [optional] +**trigger_id** | **str** | ID of trigger subscribed to. | [required] +**trigger_name** | **str** | Trigger name of trigger subscribed to. | [required] +**type** | [**SubscriptionType**](subscription-type) | | [required] +**response_deadline** | **str** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to 'PT1H'] +**http_config** | [**HttpConfig**](http-config) | | [optional] +**event_bridge_config** | [**EventBridgeConfig**](event-bridge-config) | | [optional] +**enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [required][default to True] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.subscription import Subscription + +subscription = Subscription( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='Access request subscription', +description='Access requested to site xyz', +trigger_id='idn:access-request-post-approval', +trigger_name='Access Requested', +type='HTTP', +response_deadline='PT1H', +http_config=sailpoint.beta.models.http_config.HttpConfig( + url = 'https://www.example.com', + http_dispatch_mode = 'SYNC', + http_authentication_type = 'NO_AUTH', + basic_auth_config = sailpoint.beta.models.basic_auth_config.BasicAuthConfig( + user_name = 'user@example.com', + password = '', ), + bearer_token_auth_config = sailpoint.beta.models.bearer_token_auth_config.BearerTokenAuthConfig( + bearer_token = '', ), ), +event_bridge_config=sailpoint.beta.models.event_bridge_config.EventBridgeConfig( + aws_account = '123456789012', + aws_region = 'us-west-1', ), +enabled=True, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..be754a81d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,38 @@ +--- +id: beta-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPatchRequestInner', 'BetaSubscriptionPatchRequestInner'] +slug: /tools/sdk/python/beta/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'BetaSubscriptionPatchRequestInner'] +--- + +# SubscriptionPatchRequestInner + +A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy' ] | The operation to be performed | [required] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.subscription_patch_request_inner import SubscriptionPatchRequestInner + +subscription_patch_request_inner = SubscriptionPatchRequestInner( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..338e4f26d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,32 @@ +--- +id: beta-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPatchRequestInnerValue', 'BetaSubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/python/beta/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'BetaSubscriptionPatchRequestInnerValue'] +--- + +# SubscriptionPatchRequestInnerValue + +The value to be used for the operation, required for \"add\" and \"replace\" operations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.subscription_patch_request_inner_value import SubscriptionPatchRequestInnerValue + +subscription_patch_request_inner_value = SubscriptionPatchRequestInnerValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..09685119a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,31 @@ +--- +id: beta-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'BetaSubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/python/beta/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'BetaSubscriptionPatchRequestInnerValueAnyOfInner'] +--- + +# SubscriptionPatchRequestInnerValueAnyOfInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.subscription_patch_request_inner_value_any_of_inner import SubscriptionPatchRequestInnerValueAnyOfInner + +subscription_patch_request_inner_value_any_of_inner = SubscriptionPatchRequestInnerValueAnyOfInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPostRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..568b6a87c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPostRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPostRequest', 'BetaSubscriptionPostRequest'] +slug: /tools/sdk/python/beta/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'BetaSubscriptionPostRequest'] +--- + +# SubscriptionPostRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Subscription name. | [required] +**description** | **str** | Subscription description. | [optional] +**trigger_id** | **str** | ID of trigger subscribed to. | [required] +**type** | [**SubscriptionType**](subscription-type) | | [required] +**response_deadline** | **str** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to 'PT1H'] +**http_config** | [**HttpConfig**](http-config) | | [optional] +**event_bridge_config** | [**EventBridgeConfig**](event-bridge-config) | | [optional] +**enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to True] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.subscription_post_request import SubscriptionPostRequest + +subscription_post_request = SubscriptionPostRequest( +name='Access request subscription', +description='Access requested to site xyz', +trigger_id='idn:access-requested', +type='HTTP', +response_deadline='PT1H', +http_config=sailpoint.beta.models.http_config.HttpConfig( + url = 'https://www.example.com', + http_dispatch_mode = 'SYNC', + http_authentication_type = 'NO_AUTH', + basic_auth_config = sailpoint.beta.models.basic_auth_config.BasicAuthConfig( + user_name = 'user@example.com', + password = '', ), + bearer_token_auth_config = sailpoint.beta.models.bearer_token_auth_config.BearerTokenAuthConfig( + bearer_token = '', ), ), +event_bridge_config=sailpoint.beta.models.event_bridge_config.EventBridgeConfig( + aws_account = '123456789012', + aws_region = 'us-west-1', ), +enabled=True, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPutRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..1bdca21c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionPutRequest.md @@ -0,0 +1,57 @@ +--- +id: beta-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPutRequest', 'BetaSubscriptionPutRequest'] +slug: /tools/sdk/python/beta/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'BetaSubscriptionPutRequest'] +--- + +# SubscriptionPutRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Subscription name. | [optional] +**description** | **str** | Subscription description. | [optional] +**type** | [**SubscriptionType**](subscription-type) | | [optional] +**response_deadline** | **str** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to 'PT1H'] +**http_config** | [**HttpConfig**](http-config) | | [optional] +**event_bridge_config** | [**EventBridgeConfig**](event-bridge-config) | | [optional] +**enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to True] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.subscription_put_request import SubscriptionPutRequest + +subscription_put_request = SubscriptionPutRequest( +name='Access request subscription', +description='Access requested to site xyz', +type='HTTP', +response_deadline='PT1H', +http_config=sailpoint.beta.models.http_config.HttpConfig( + url = 'https://www.example.com', + http_dispatch_mode = 'SYNC', + http_authentication_type = 'NO_AUTH', + basic_auth_config = sailpoint.beta.models.basic_auth_config.BasicAuthConfig( + user_name = 'user@example.com', + password = '', ), + bearer_token_auth_config = sailpoint.beta.models.bearer_token_auth_config.BearerTokenAuthConfig( + bearer_token = '', ), ), +event_bridge_config=sailpoint.beta.models.event_bridge_config.EventBridgeConfig( + aws_account = '123456789012', + aws_region = 'us-west-1', ), +enabled=True, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionType.md b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionType.md new file mode 100644 index 000000000..2ee79c241 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SubscriptionType.md @@ -0,0 +1,29 @@ +--- +id: beta-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionType', 'BetaSubscriptionType'] +slug: /tools/sdk/python/beta/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'BetaSubscriptionType'] +--- + +# SubscriptionType + +Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. + +## Enum + +* `HTTP` (value: `'HTTP'`) + +* `EVENTBRIDGE` (value: `'EVENTBRIDGE'`) + +* `INLINE` (value: `'INLINE'`) + +* `SCRIPT` (value: `'SCRIPT'`) + +* `WORKFLOW` (value: `'WORKFLOW'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Tag.md b/docs/tools/sdk/python/Reference/Beta/Models/Tag.md new file mode 100644 index 000000000..9457a591f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Tag.md @@ -0,0 +1,46 @@ +--- +id: beta-tag +title: Tag +pagination_label: Tag +sidebar_label: Tag +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tag', 'BetaTag'] +slug: /tools/sdk/python/beta/models/tag +tags: ['SDK', 'Software Development Kit', 'Tag', 'BetaTag'] +--- + +# Tag + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Tag id | [required][readonly] +**name** | **str** | Name of the tag. | [required] +**created** | **datetime** | Date the tag was created. | [required][readonly] +**modified** | **datetime** | Date the tag was last modified. | [required][readonly] +**tag_category_refs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly] +} + +## Example + +```python +from sailpoint.beta.models.tag import Tag + +tag = Tag( +id='449ecdc0-d4ff-4341-acf6-92f6f7ce604f', +name='PCI', +created='2022-05-04T14:48:49Z', +modified='2022-07-14T16:31:11Z', +tag_category_refs=[ + sailpoint.beta.models.tag_tag_category_refs_inner.Tag_tagCategoryRefs_inner( + 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/Beta/Models/TagTagCategoryRefsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/TagTagCategoryRefsInner.md new file mode 100644 index 000000000..8380c3614 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TagTagCategoryRefsInner.md @@ -0,0 +1,38 @@ +--- +id: beta-tag-tag-category-refs-inner +title: TagTagCategoryRefsInner +pagination_label: TagTagCategoryRefsInner +sidebar_label: TagTagCategoryRefsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TagTagCategoryRefsInner', 'BetaTagTagCategoryRefsInner'] +slug: /tools/sdk/python/beta/models/tag-tag-category-refs-inner +tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'BetaTagTagCategoryRefsInner'] +--- + +# TagTagCategoryRefsInner + +Tagged object's category. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | DTO type of the tagged object's category. | [optional] +**id** | **str** | Tagged object's ID. | [optional] +**name** | **str** | Tagged object's display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tag_tag_category_refs_inner import TagTagCategoryRefsInner + +tag_tag_category_refs_inner = TagTagCategoryRefsInner( +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/Beta/Models/TaggedObject.md b/docs/tools/sdk/python/Reference/Beta/Models/TaggedObject.md new file mode 100644 index 000000000..e13dd603c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaggedObject.md @@ -0,0 +1,38 @@ +--- +id: beta-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObject', 'BetaTaggedObject'] +slug: /tools/sdk/python/beta/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'BetaTaggedObject'] +--- + +# TaggedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_ref** | [**TaggedObjectObjectRef**](tagged-object-object-ref) | | [optional] +**tags** | **[]str** | Labels to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tagged_object import TaggedObject + +tagged_object = TaggedObject( +object_ref=sailpoint.beta.models.tagged_object_object_ref.TaggedObject_objectRef( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaggedObjectDto.md b/docs/tools/sdk/python/Reference/Beta/Models/TaggedObjectDto.md new file mode 100644 index 000000000..31e45a2c5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaggedObjectDto.md @@ -0,0 +1,37 @@ +--- +id: beta-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObjectDto', 'BetaTaggedObjectDto'] +slug: /tools/sdk/python/beta/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'BetaTaggedObjectDto'] +--- + +# TaggedObjectDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | DTO type | [optional] +**id** | **str** | ID of the object this reference applies to | [optional] +**name** | **str** | Human-readable display name of the object this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tagged_object_dto import TaggedObjectDto + +tagged_object_dto = TaggedObjectDto( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaggedObjectObjectRef.md b/docs/tools/sdk/python/Reference/Beta/Models/TaggedObjectObjectRef.md new file mode 100644 index 000000000..e55c2533a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaggedObjectObjectRef.md @@ -0,0 +1,37 @@ +--- +id: beta-tagged-object-object-ref +title: TaggedObjectObjectRef +pagination_label: TaggedObjectObjectRef +sidebar_label: TaggedObjectObjectRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObjectObjectRef', 'BetaTaggedObjectObjectRef'] +slug: /tools/sdk/python/beta/models/tagged-object-object-ref +tags: ['SDK', 'Software Development Kit', 'TaggedObjectObjectRef', 'BetaTaggedObjectObjectRef'] +--- + +# TaggedObjectObjectRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | 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.beta.models.tagged_object_object_ref import TaggedObjectObjectRef + +tagged_object_object_ref = TaggedObjectObjectRef( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Target.md b/docs/tools/sdk/python/Reference/Beta/Models/Target.md new file mode 100644 index 000000000..14eaea9d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Target.md @@ -0,0 +1,37 @@ +--- +id: beta-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Target', 'BetaTarget'] +slug: /tools/sdk/python/beta/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'BetaTarget'] +--- + +# Target + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Target ID | [optional] +**type** | **Enum** [ 'APPLICATION', 'IDENTITY' ] | Target type | [optional] +**name** | **str** | Target name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.target import Target + +target = Target( +id='c6dc37bf508149b28ce5b7d90ca4bbf9', +type='APPLICATION', +name='Active Directory [source]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskDefinitionSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..d73e01e03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskDefinitionSummary.md @@ -0,0 +1,44 @@ +--- +id: beta-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskDefinitionSummary', 'BetaTaskDefinitionSummary'] +slug: /tools/sdk/python/beta/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'BetaTaskDefinitionSummary'] +--- + +# TaskDefinitionSummary + +Definition of a type of task, used to invoke tasks + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the TaskDefinition | [required] +**unique_name** | **str** | Name of the TaskDefinition | [required] +**description** | **str** | Description of the TaskDefinition | [required] +**parent_name** | **str** | Name of the parent of the TaskDefinition | [required] +**executor** | **str** | Executor of the TaskDefinition | [required] +**arguments** | **map[string]object** | Formal parameters of the TaskDefinition, without values | [required] +} + +## Example + +```python +from sailpoint.beta.models.task_definition_summary import TaskDefinitionSummary + +task_definition_summary = TaskDefinitionSummary( +id='2c91808475b4334b0175e1dff64b63c5', +unique_name='Cloud Account Aggregation', +description='Aggregates from the specified application.', +parent_name='Cloud Account Aggregation', +executor='sailpoint.task.ServiceTaskExecutor', +arguments={ } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskResultDto.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskResultDto.md new file mode 100644 index 000000000..ea9bc9f07 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskResultDto.md @@ -0,0 +1,38 @@ +--- +id: beta-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDto', 'BetaTaskResultDto'] +slug: /tools/sdk/python/beta/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'BetaTaskResultDto'] +--- + +# TaskResultDto + +Task result. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'TASK_RESULT' ] | Task result DTO type. | [optional] +**id** | **str** | Task result ID. | [optional] +**name** | **str** | Task result display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.task_result_dto import TaskResultDto + +task_result_dto = TaskResultDto( +type='TASK_RESULT', +id='464ae7bf791e49fdb74606a2e4a89635', +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskResultResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskResultResponse.md new file mode 100644 index 000000000..150178598 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskResultResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultResponse', 'BetaTaskResultResponse'] +slug: /tools/sdk/python/beta/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'BetaTaskResultResponse'] +--- + +# TaskResultResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | the type of response reference | [optional] +**id** | **str** | the task ID | [optional] +**name** | **str** | the task name (not used in this endpoint, always null) | [optional] +} + +## Example + +```python +from sailpoint.beta.models.task_result_response import TaskResultResponse + +task_result_response = TaskResultResponse( +type='TASK_RESULT', +id='78733556-9ea3-4f59-bf69-e5cd92b011b4', +name='null' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskResultSimplified.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskResultSimplified.md new file mode 100644 index 000000000..bd7b8fe19 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskResultSimplified.md @@ -0,0 +1,45 @@ +--- +id: beta-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultSimplified', 'BetaTaskResultSimplified'] +slug: /tools/sdk/python/beta/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'BetaTaskResultSimplified'] +--- + +# TaskResultSimplified + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Task identifier | [optional] +**name** | **str** | Task name | [optional] +**description** | **str** | Task description | [optional] +**launcher** | **str** | User or process who launched the task | [optional] +**completed** | **datetime** | Date time of completion | [optional] +**launched** | **datetime** | Date time when the task was launched | [optional] +**completion_status** | **Enum** [ 'Success', 'Warning', 'Error', 'Terminated', 'TempError' ] | Task result status | [optional] +} + +## Example + +```python +from sailpoint.beta.models.task_result_simplified import TaskResultSimplified + +task_result_simplified = TaskResultSimplified( +id='ff8081814d977c21014da056804a0af3', +name='Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d', +description='Generic task for terminating data in the overlay, used by the TerminationService.', +launcher='support', +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskReturnDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskReturnDetails.md new file mode 100644 index 000000000..12efadf74 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskReturnDetails.md @@ -0,0 +1,36 @@ +--- +id: beta-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskReturnDetails', 'BetaTaskReturnDetails'] +slug: /tools/sdk/python/beta/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'BetaTaskReturnDetails'] +--- + +# TaskReturnDetails + +Task return details + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Display name of the TaskReturnDetails | [required] +**attribute_name** | **str** | Attribute the TaskReturnDetails is for | [required] +} + +## Example + +```python +from sailpoint.beta.models.task_return_details import TaskReturnDetails + +task_return_details = TaskReturnDetails( +name='label', +attribute_name='identityCount' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskStatus.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskStatus.md new file mode 100644 index 000000000..b6de34aed --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskStatus.md @@ -0,0 +1,89 @@ +--- +id: beta-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskStatus', 'BetaTaskStatus'] +slug: /tools/sdk/python/beta/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'BetaTaskStatus'] +--- + +# TaskStatus + +Details and current status of a specific task + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this TaskStatus represents | [required] +**type** | **Enum** [ 'QUARTZ', 'QPOC', 'QUEUED_TASK' ] | Type of task this TaskStatus represents | [required] +**unique_name** | **str** | Name of the task this TaskStatus represents | [required] +**description** | **str** | Description of the task this TaskStatus represents | [required] +**parent_name** | **str** | Name of the parent of the task this TaskStatus represents | [required] +**launcher** | **str** | Service to execute the task this TaskStatus represents | [required] +**target** | [**Target**](target) | | [optional] +**created** | **datetime** | Creation date of the task this TaskStatus represents | [required] +**modified** | **datetime** | Last modification date of the task this TaskStatus represents | [required] +**launched** | **datetime** | Launch date of the task this TaskStatus represents | [required] +**completed** | **datetime** | Completion date of the task this TaskStatus represents | [required] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMPERROR' ] | Completion status of the task this TaskStatus represents | [required] +**messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | [required] +**returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | [required] +**attributes** | **map[string]object** | Attributes of the task this TaskStatus represents | [required] +**progress** | **str** | Current progress of the task this TaskStatus represents | [required] +**percent_complete** | **int** | Current percentage completion of the task this TaskStatus represents | [required] +**task_definition_summary** | [**TaskDefinitionSummary**](task-definition-summary) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.task_status import TaskStatus + +task_status = TaskStatus( +id='id12345', +type='QUARTZ', +unique_name='Big Task', +description='A Really Big Task', +parent_name='Parent Task', +launcher='sweep', +target=sailpoint.beta.models.target.Target( + id = 'c6dc37bf508149b28ce5b7d90ca4bbf9', + type = 'APPLICATION', + name = 'Active Directory [source]', ), +created='2020-07-11T21:23:15Z', +modified='2020-07-11T21:23:15Z', +launched='2020-07-11T21:23:15Z', +completed='2020-07-11T21:23:15Z', +completion_status='SUCCESS', +messages=[ + sailpoint.beta.models.task_status_message.TaskStatusMessage( + type = 'INFO', + localized_text = sailpoint.beta.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), + key = 'akey', + parameters = [{name=value}], ) + ], +returns=[ + sailpoint.beta.models.task_return_details.TaskReturnDetails( + name = 'label', + attribute_name = 'identityCount', ) + ], +attributes={identityCount=0}, +progress='Started', +percent_complete=100, +task_definition_summary=sailpoint.beta.models.task_definition_summary.TaskDefinitionSummary( + id = '2c91808475b4334b0175e1dff64b63c5', + unique_name = 'Cloud Account Aggregation', + description = 'Aggregates from the specified application.', + parent_name = 'Cloud Account Aggregation', + executor = 'sailpoint.task.ServiceTaskExecutor', + arguments = { }, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskStatusMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskStatusMessage.md new file mode 100644 index 000000000..2803b88d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskStatusMessage.md @@ -0,0 +1,42 @@ +--- +id: beta-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskStatusMessage', 'BetaTaskStatusMessage'] +slug: /tools/sdk/python/beta/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'BetaTaskStatusMessage'] +--- + +# TaskStatusMessage + +TaskStatus Message + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message | [required] +**localized_text** | [**LocalizedMessage**](localized-message) | | [required] +**key** | **str** | Key of the message | [required] +**parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | [required] +} + +## Example + +```python +from sailpoint.beta.models.task_status_message import TaskStatusMessage + +task_status_message = TaskStatusMessage( +type='INFO', +localized_text=sailpoint.beta.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), +key='akey', +parameters=[{name=value}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/python/Reference/Beta/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..2c4310295 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,31 @@ +--- +id: beta-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskStatusMessageParametersInner', 'BetaTaskStatusMessageParametersInner'] +slug: /tools/sdk/python/beta/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'BetaTaskStatusMessageParametersInner'] +--- + +# TaskStatusMessageParametersInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.task_status_message_parameters_inner import TaskStatusMessageParametersInner + +task_status_message_parameters_inner = TaskStatusMessageParametersInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..3f6f1398a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,37 @@ +--- +id: beta-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateBulkDeleteDto', 'BetaTemplateBulkDeleteDto'] +slug: /tools/sdk/python/beta/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'BetaTemplateBulkDeleteDto'] +--- + +# TemplateBulkDeleteDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [required] +**medium** | **Enum** [ 'EMAIL', 'PHONE', 'SMS' ] | | [optional] +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_bulk_delete_dto import TemplateBulkDeleteDto + +template_bulk_delete_dto = TemplateBulkDeleteDto( +key='cloud_manual_work_item_summary', +medium='EMAIL', +locale='en' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateDto.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateDto.md new file mode 100644 index 000000000..fd463399a --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateDto.md @@ -0,0 +1,63 @@ +--- +id: beta-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateDto', 'BetaTemplateDto'] +slug: /tools/sdk/python/beta/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'BetaTemplateDto'] +--- + +# TemplateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the template | [required] +**name** | **str** | The name of the Task Manager Subscription | [optional] +**medium** | **Enum** [ 'EMAIL', 'PHONE', 'SMS', 'SLACK', 'TEAMS' ] | The message medium. More mediums may be added in the future. | [required] +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [required] +**subject** | **str** | The subject line in the template | [optional] +**header** | **str** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**body** | **str** | The body in the template | [optional] +**footer** | **str** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**var_from** | **str** | The \"From:\" address in the template | [optional] +**reply_to** | **str** | The \"Reply To\" line in the template | [optional] +**description** | **str** | The description in the template | [optional] +**id** | **str** | This is auto-generated. | [optional] +**created** | **datetime** | The time when this template is created. This is auto-generated. | [optional] +**modified** | **datetime** | The time when this template was last modified. This is auto-generated. | [optional] +**slack_template** | **str** | | [optional] +**teams_template** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_dto import TemplateDto + +template_dto = TemplateDto( +key='cloud_manual_work_item_summary', +name='Task Manager Subscription', +medium='EMAIL', +locale='en', +subject='You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.', +header='', +body='Please go to the task manager', +footer='', +var_from='$__global.emailFromAddress', +reply_to='$__global.emailFromAddress', +description='Daily digest - sent if number of outstanding tasks for task owner > 0', +id='c17bea3a-574d-453c-9e04-4365fbf5af0b', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +slack_template='', +teams_template='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateDtoDefault.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..863080897 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateDtoDefault.md @@ -0,0 +1,97 @@ +--- +id: beta-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateDtoDefault', 'BetaTemplateDtoDefault'] +slug: /tools/sdk/python/beta/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'BetaTemplateDtoDefault'] +--- + +# TemplateDtoDefault + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the default template | [optional] +**name** | **str** | The name of the default template | [optional] +**medium** | **Enum** [ 'EMAIL', 'PHONE', 'SMS', 'SLACK', 'TEAMS' ] | The message medium. More mediums may be added in the future. | [optional] +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional] +**subject** | **str** | The subject of the default template | [optional] +**header** | **str** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**body** | **str** | The body of the default template | [optional] +**footer** | **str** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**var_from** | **str** | The \"From:\" address of the default template | [optional] +**reply_to** | **str** | The \"Reply To\" field of the default template | [optional] +**description** | **str** | The description of the default template | [optional] +**slack_template** | [**TemplateSlack**](template-slack) | | [optional] +**teams_template** | [**TemplateTeams**](template-teams) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_dto_default import TemplateDtoDefault + +template_dto_default = TemplateDtoDefault( +key='cloud_manual_work_item_summary', +name='Task Manager Subscription', +medium='EMAIL', +locale='en', +subject='You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.', +header='', +body='Please go to the task manager', +footer='', +var_from='$__global.emailFromAddress', +reply_to='$__global.emailFromAddress', +description='Daily digest - sent if number of outstanding tasks for task owner > 0', +slack_template=sailpoint.beta.models.template_slack.TemplateSlack( + key = '', + text = '', + blocks = '', + attachments = '', + notification_type = '', + approval_id = '', + request_id = '', + requested_by_id = '', + is_subscription = True, + auto_approval_data = sailpoint.beta.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), + custom_fields = sailpoint.beta.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ), ), +teams_template=sailpoint.beta.models.template_teams.TemplateTeams( + key = '', + title = '', + text = '', + message_json = '', + is_subscription = True, + approval_id = '', + request_id = '', + requested_by_id = '', + notification_type = '', + auto_approval_data = sailpoint.beta.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), + custom_fields = sailpoint.beta.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlack.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlack.md new file mode 100644 index 000000000..bc218f930 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlack.md @@ -0,0 +1,62 @@ +--- +id: beta-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateSlack', 'BetaTemplateSlack'] +slug: /tools/sdk/python/beta/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'BetaTemplateSlack'] +--- + +# TemplateSlack + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [optional] +**text** | **str** | | [optional] +**blocks** | **str** | | [optional] +**attachments** | **str** | | [optional] +**notification_type** | **str** | | [optional] +**approval_id** | **str** | | [optional] +**request_id** | **str** | | [optional] +**requested_by_id** | **str** | | [optional] +**is_subscription** | **bool** | | [optional] +**auto_approval_data** | [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**custom_fields** | [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_slack import TemplateSlack + +template_slack = TemplateSlack( +key='', +text='', +blocks='', +attachments='', +notification_type='', +approval_id='', +request_id='', +requested_by_id='', +is_subscription=True, +auto_approval_data=sailpoint.beta.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), +custom_fields=sailpoint.beta.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..c4bf2aa86 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,41 @@ +--- +id: beta-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateSlackAutoApprovalData', 'BetaTemplateSlackAutoApprovalData'] +slug: /tools/sdk/python/beta/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'BetaTemplateSlackAutoApprovalData'] +--- + +# TemplateSlackAutoApprovalData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**is_auto_approved** | **str** | | [optional] +**item_id** | **str** | | [optional] +**item_type** | **str** | | [optional] +**auto_approval_message_json** | **str** | | [optional] +**auto_approval_title** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_slack_auto_approval_data import TemplateSlackAutoApprovalData + +template_slack_auto_approval_data = TemplateSlackAutoApprovalData( +is_auto_approved='', +item_id='', +item_type='', +auto_approval_message_json='', +auto_approval_title='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..885beb11f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateSlackCustomFields.md @@ -0,0 +1,39 @@ +--- +id: beta-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateSlackCustomFields', 'BetaTemplateSlackCustomFields'] +slug: /tools/sdk/python/beta/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'BetaTemplateSlackCustomFields'] +--- + +# TemplateSlackCustomFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_type** | **str** | | [optional] +**contains_deny** | **str** | | [optional] +**campaign_id** | **str** | | [optional] +**campaign_status** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_slack_custom_fields import TemplateSlackCustomFields + +template_slack_custom_fields = TemplateSlackCustomFields( +request_type='', +contains_deny='', +campaign_id='', +campaign_status='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TemplateTeams.md b/docs/tools/sdk/python/Reference/Beta/Models/TemplateTeams.md new file mode 100644 index 000000000..f7563f60c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TemplateTeams.md @@ -0,0 +1,62 @@ +--- +id: beta-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateTeams', 'BetaTemplateTeams'] +slug: /tools/sdk/python/beta/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'BetaTemplateTeams'] +--- + +# TemplateTeams + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [optional] +**title** | **str** | | [optional] +**text** | **str** | | [optional] +**message_json** | **str** | | [optional] +**is_subscription** | **bool** | | [optional] +**approval_id** | **str** | | [optional] +**request_id** | **str** | | [optional] +**requested_by_id** | **str** | | [optional] +**notification_type** | **str** | | [optional] +**auto_approval_data** | [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**custom_fields** | [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.template_teams import TemplateTeams + +template_teams = TemplateTeams( +key='', +title='', +text='', +message_json='', +is_subscription=True, +approval_id='', +request_id='', +requested_by_id='', +notification_type='', +auto_approval_data=sailpoint.beta.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), +custom_fields=sailpoint.beta.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Tenant.md b/docs/tools/sdk/python/Reference/Beta/Models/Tenant.md new file mode 100644 index 000000000..0e65255b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Tenant.md @@ -0,0 +1,67 @@ +--- +id: beta-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tenant', 'BetaTenant'] +slug: /tools/sdk/python/beta/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant'] +--- + +# Tenant + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier for the Tenant | [optional] [readonly] +**name** | **str** | Abbreviated name of the Tenant | [optional] +**full_name** | **str** | Human-readable name of the Tenant | [optional] +**pod** | **str** | Deployment pod for the Tenant | [optional] +**region** | **str** | Deployment region for the Tenant | [optional] +**description** | **str** | Description of the Tenant | [optional] +**products** | [**[]Product**](product) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tenant import Tenant + +tenant = Tenant( +id='2c91808568c529c60168cca6f90c1324', +name='acme', +full_name='Acme, Inc', +pod='example-pod', +region='us-east-1', +description='Description of the Tenant', +products=[ + sailpoint.beta.models.product.Product( + product_name = 'idn', + url = 'https://tenant-name.identitynow.com', + product_tenant_id = 'tenant#product', + product_region = 'us-east-1', + product_right = 'idn:ui:view', + api_url = 'https://tenant-name.api.identitynow.com', + licenses = [ + sailpoint.beta.models.license.License( + license_id = 'idn:access-request', + legacy_feature_name = 'ACCESS_REQUEST', ) + ], + attributes = {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250}, + zone = 'Deployment zone for the Product', + status = 'active', + status_date_time = '2020-05-19T13:49:37.385Z', + reason = 'Reason', + notes = 'Example notes', + date_created = '2020-05-19T13:49:37.385Z', + last_updated = '2020-05-19T13:49:37.385Z', + org_type = 'test', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationDetails.md b/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..cd24978d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationDetails.md @@ -0,0 +1,34 @@ +--- +id: beta-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantConfigurationDetails', 'BetaTenantConfigurationDetails'] +slug: /tools/sdk/python/beta/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'BetaTenantConfigurationDetails'] +--- + +# TenantConfigurationDetails + +Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**disabled** | **bool** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.tenant_configuration_details import TenantConfigurationDetails + +tenant_configuration_details = TenantConfigurationDetails( +disabled=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..62c09eaf0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantConfigurationRequest', 'BetaTenantConfigurationRequest'] +slug: /tools/sdk/python/beta/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'BetaTenantConfigurationRequest'] +--- + +# TenantConfigurationRequest + +Tenant-wide Reassignment Configuration settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config_details** | [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tenant_configuration_request import TenantConfigurationRequest + +tenant_configuration_request = TenantConfigurationRequest( +config_details=sailpoint.beta.models.tenant_configuration_details.TenantConfigurationDetails( + disabled = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..8026a305f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TenantConfigurationResponse.md @@ -0,0 +1,45 @@ +--- +id: beta-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantConfigurationResponse', 'BetaTenantConfigurationResponse'] +slug: /tools/sdk/python/beta/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'BetaTenantConfigurationResponse'] +--- + +# TenantConfigurationResponse + +Tenant-wide Reassignment Configuration settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audit_details** | [**AuditDetails**](audit-details) | | [optional] +**config_details** | [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tenant_configuration_response import TenantConfigurationResponse + +tenant_configuration_response = TenantConfigurationResponse( +audit_details=sailpoint.beta.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = sailpoint.beta.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), ), +config_details=sailpoint.beta.models.tenant_configuration_details.TenantConfigurationDetails( + disabled = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..386015a15 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantUiMetadataItemResponse', 'BetaTenantUiMetadataItemResponse'] +slug: /tools/sdk/python/beta/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'BetaTenantUiMetadataItemResponse'] +--- + +# TenantUiMetadataItemResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iframe_white_list** | **str** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**username_label** | **str** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**username_empty_text** | **str** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse + +tenant_ui_metadata_item_response = TenantUiMetadataItemResponse( +iframe_white_list='http://example.com http://example2.com', +username_label='Email', +username_empty_text='Please provide your work email address...' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..dba61bc69 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'BetaTenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/python/beta/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'BetaTenantUiMetadataItemUpdateRequest'] +--- + +# TenantUiMetadataItemUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iframe_white_list** | **str** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**username_label** | **str** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**username_empty_text** | **str** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] +} + +## Example + +```python +from sailpoint.beta.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest + +tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest( +iframe_white_list='http://example.com http://example2.com', +username_label='Email', +username_empty_text='Please provide your work email address...' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..0c8f3be3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,33 @@ +--- +id: beta-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestExternalExecuteWorkflow200Response', 'BetaTestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/python/beta/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'BetaTestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payload** | **object** | The input that was received | [optional] +} + +## Example + +```python +from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + +test_external_execute_workflow200_response = TestExternalExecuteWorkflow200Response( +payload={test=hello world} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..002d58351 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestExternalExecuteWorkflowRequest', 'BetaTestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/python/beta/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'BetaTestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow | [optional] +} + +## Example + +```python +from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + +test_external_execute_workflow_request = TestExternalExecuteWorkflowRequest( +input={test=hello world} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TestInvocation.md b/docs/tools/sdk/python/Reference/Beta/Models/TestInvocation.md new file mode 100644 index 000000000..a56e745e9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TestInvocation.md @@ -0,0 +1,39 @@ +--- +id: beta-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestInvocation', 'BetaTestInvocation'] +slug: /tools/sdk/python/beta/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'BetaTestInvocation'] +--- + +# TestInvocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trigger_id** | **str** | Trigger ID | [required] +**input** | **object** | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**content_json** | **object** | JSON map of invocation metadata. | [required] +**subscription_ids** | **[]str** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.test_invocation import TestInvocation + +test_invocation = TestInvocation( +trigger_id='idn:access-request-post-approval', +input={identityId=201327fda1c44704ac01181e963d463c}, +content_json={workflowId=1234}, +subscription_ids=[0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TestSourceConnectionMultihost200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/TestSourceConnectionMultihost200Response.md new file mode 100644 index 000000000..0ee556723 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TestSourceConnectionMultihost200Response.md @@ -0,0 +1,41 @@ +--- +id: beta-test-source-connection-multihost200-response +title: TestSourceConnectionMultihost200Response +pagination_label: TestSourceConnectionMultihost200Response +sidebar_label: TestSourceConnectionMultihost200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestSourceConnectionMultihost200Response', 'BetaTestSourceConnectionMultihost200Response'] +slug: /tools/sdk/python/beta/models/test-source-connection-multihost200-response +tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'BetaTestSourceConnectionMultihost200Response'] +--- + +# TestSourceConnectionMultihost200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | Source's test connection status. | [optional] +**message** | **str** | Source's test connection message. | [optional] +**timing** | **int** | Source's test connection timing. | [optional] +**result_type** | **Enum** [ 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' ] | Source's human-readable result type. | [optional] +**test_connection_details** | **str** | Source's human-readable test connection details. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response + +test_source_connection_multihost200_response = TestSourceConnectionMultihost200Response( +success=True, +message='Tes.', +timing=56, +result_type=SOURCE_STATE_HEALTHY, +test_connection_details='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TestWorkflow200Response.md b/docs/tools/sdk/python/Reference/Beta/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..de367bc8d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TestWorkflow200Response.md @@ -0,0 +1,33 @@ +--- +id: beta-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestWorkflow200Response', 'BetaTestWorkflow200Response'] +slug: /tools/sdk/python/beta/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'BetaTestWorkflow200Response'] +--- + +# TestWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflow_execution_id** | **str** | The workflow execution id | [optional] +} + +## Example + +```python +from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + +test_workflow200_response = TestWorkflow200Response( +workflow_execution_id='0e11cefa-96e7-4b67-90d0-065bc1da5753' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TestWorkflowRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..07a4f6599 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TestWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestWorkflowRequest', 'BetaTestWorkflowRequest'] +slug: /tools/sdk/python/beta/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'BetaTestWorkflowRequest'] +--- + +# TestWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow. | [required] +} + +## Example + +```python +from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + +test_workflow_request = TestWorkflowRequest( +input=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TokenAuthRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/TokenAuthRequest.md new file mode 100644 index 000000000..c7298f041 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TokenAuthRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-token-auth-request +title: TokenAuthRequest +pagination_label: TokenAuthRequest +sidebar_label: TokenAuthRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TokenAuthRequest', 'BetaTokenAuthRequest'] +slug: /tools/sdk/python/beta/models/token-auth-request +tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest', 'BetaTokenAuthRequest'] +--- + +# TokenAuthRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token** | **str** | Token value | [required] +**user_alias** | **str** | User alias from table spt_identity field named 'name' | [required] +**delivery_type** | **Enum** [ 'SMS_PERSONAL', 'VOICE_PERSONAL', 'SMS_WORK', 'VOICE_WORK', 'EMAIL_WORK', 'EMAIL_PERSONAL' ] | Token delivery type | [required] +} + +## Example + +```python +from sailpoint.beta.models.token_auth_request import TokenAuthRequest + +token_auth_request = TokenAuthRequest( +token='12345', +user_alias='will.albin', +delivery_type='EMAIL_WORK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TokenAuthResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/TokenAuthResponse.md new file mode 100644 index 000000000..c3ddf787c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TokenAuthResponse.md @@ -0,0 +1,33 @@ +--- +id: beta-token-auth-response +title: TokenAuthResponse +pagination_label: TokenAuthResponse +sidebar_label: TokenAuthResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TokenAuthResponse', 'BetaTokenAuthResponse'] +slug: /tools/sdk/python/beta/models/token-auth-response +tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse', 'BetaTokenAuthResponse'] +--- + +# TokenAuthResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED', 'LOCKOUT', 'NOT_ENOUGH_DATA' ] | MFA Authentication status | [optional] +} + +## Example + +```python +from sailpoint.beta.models.token_auth_response import TokenAuthResponse + +token_auth_response = TokenAuthResponse( +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Transform.md b/docs/tools/sdk/python/Reference/Beta/Models/Transform.md new file mode 100644 index 000000000..d1ef0f9fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Transform.md @@ -0,0 +1,38 @@ +--- +id: beta-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Transform', 'BetaTransform'] +slug: /tools/sdk/python/beta/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'BetaTransform'] +--- + +# Transform + +The representation of an internally- or customer-defined transform. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unique name of this transform | [required] +**type** | **Enum** [ 'accountAttribute', 'base64Decode', 'base64Encode', 'concat', 'conditional', 'dateCompare', 'dateFormat', 'dateMath', 'decomposeDiacriticalMarks', 'e164phone', 'firstValid', 'rule', 'identityAttribute', 'indexOf', 'iso3166', 'lastIndexOf', 'leftPad', 'lookup', 'lower', 'normalizeNames', 'randomAlphaNumeric', 'randomNumeric', 'reference', 'replaceAll', 'replace', 'rightPad', 'split', 'static', 'substring', 'trim', 'upper', 'usernameGenerator', 'uuid', 'displayName', 'rfc5646' ] | The type of transform operation | [required] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [required] +} + +## Example + +```python +from sailpoint.beta.models.transform import Transform + +transform = Transform( +name='Timestamp To Date', +type='dateFormat', +attributes=sailpoint.beta.models.attributes.attributes() +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TransformDefinition.md b/docs/tools/sdk/python/Reference/Beta/Models/TransformDefinition.md new file mode 100644 index 000000000..becc6d5a1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TransformDefinition.md @@ -0,0 +1,35 @@ +--- +id: beta-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformDefinition', 'BetaTransformDefinition'] +slug: /tools/sdk/python/beta/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformDefinition'] +--- + +# TransformDefinition + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Transform definition type. | [optional] +**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional] +} + +## Example + +```python +from sailpoint.beta.models.transform_definition import TransformDefinition + +transform_definition = TransformDefinition( +type='accountAttribute', +attributes={attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TransformDefinition1.md b/docs/tools/sdk/python/Reference/Beta/Models/TransformDefinition1.md new file mode 100644 index 000000000..e92c694b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TransformDefinition1.md @@ -0,0 +1,35 @@ +--- +id: beta-transform-definition1 +title: TransformDefinition1 +pagination_label: TransformDefinition1 +sidebar_label: TransformDefinition1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformDefinition1', 'BetaTransformDefinition1'] +slug: /tools/sdk/python/beta/models/transform-definition1 +tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransformDefinition1'] +--- + +# TransformDefinition1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Transform definition type. | [optional] +**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional] +} + +## Example + +```python +from sailpoint.beta.models.transform_definition1 import TransformDefinition1 + +transform_definition1 = TransformDefinition1( +type='accountAttribute', +attributes={attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TransformRead.md b/docs/tools/sdk/python/Reference/Beta/Models/TransformRead.md new file mode 100644 index 000000000..9ed0e2d89 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TransformRead.md @@ -0,0 +1,41 @@ +--- +id: beta-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformRead', 'BetaTransformRead'] +slug: /tools/sdk/python/beta/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'BetaTransformRead'] +--- + +# TransformRead + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unique name of this transform | [required] +**type** | **Enum** [ 'accountAttribute', 'base64Decode', 'base64Encode', 'concat', 'conditional', 'dateCompare', 'dateFormat', 'dateMath', 'decomposeDiacriticalMarks', 'e164phone', 'firstValid', 'rule', 'identityAttribute', 'indexOf', 'iso3166', 'lastIndexOf', 'leftPad', 'lookup', 'lower', 'normalizeNames', 'randomAlphaNumeric', 'randomNumeric', 'reference', 'replaceAll', 'replace', 'rightPad', 'split', 'static', 'substring', 'trim', 'upper', 'usernameGenerator', 'uuid', 'displayName', 'rfc5646' ] | The type of transform operation | [required] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [required] +**id** | **str** | Unique ID of this transform | [required] +**internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to False] +} + +## Example + +```python +from sailpoint.beta.models.transform_read import TransformRead + +transform_read = TransformRead( +name='Timestamp To Date', +type='dateFormat', +attributes=sailpoint.beta.models.attributes.attributes(), +id='2cd78adghjkja34jh2b1hkjhasuecd', +internal=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TranslationMessage.md b/docs/tools/sdk/python/Reference/Beta/Models/TranslationMessage.md new file mode 100644 index 000000000..5efe11753 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TranslationMessage.md @@ -0,0 +1,35 @@ +--- +id: beta-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TranslationMessage', 'BetaTranslationMessage'] +slug: /tools/sdk/python/beta/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'BetaTranslationMessage'] +--- + +# TranslationMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the translation message | [optional] +**values** | **[]str** | The values corresponding to the translation messages | [optional] +} + +## Example + +```python +from sailpoint.beta.models.translation_message import TranslationMessage + +translation_message = TranslationMessage( +key='recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', +values=[75, department] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Trigger.md b/docs/tools/sdk/python/Reference/Beta/Models/Trigger.md new file mode 100644 index 000000000..2ee902f5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Trigger.md @@ -0,0 +1,47 @@ +--- +id: beta-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Trigger', 'BetaTrigger'] +slug: /tools/sdk/python/beta/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'BetaTrigger'] +--- + +# Trigger + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier of the trigger. | [required] +**name** | **str** | Trigger Name. | [required] +**type** | [**TriggerType**](trigger-type) | | [required] +**description** | **str** | Trigger Description. | [optional] +**input_schema** | **str** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | [required] +**example_input** | [**TriggerExampleInput**](trigger-example-input) | | [required] +**output_schema** | **str** | 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`. | [optional] +**example_output** | [**TriggerExampleOutput**](trigger-example-output) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.trigger import Trigger + +trigger = Trigger( +id='idn:access-request-dynamic-approver', +name='Access Request Dynamic Approver', +type='FIRE_AND_FORGET', +description='Trigger for getting a dynamic approver.', +input_schema='{"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"}', +example_input=, +output_schema='{"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"}', +example_output= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleInput.md b/docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleInput.md new file mode 100644 index 000000000..5887204b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleInput.md @@ -0,0 +1,257 @@ +--- +id: beta-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TriggerExampleInput', 'BetaTriggerExampleInput'] +slug: /tools/sdk/python/beta/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'BetaTriggerExampleInput'] +--- + +# TriggerExampleInput + +An example of the JSON payload that will be sent by the trigger to the subscribed service. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | The unique ID of the access request. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the collection. | [required] +**started** | **datetime** | The date and time when the account collection started. | [required] +**completed** | **datetime** | The date and time when the account collection finished. | [required] +**errors** | **[]str** | A list of any accumulated error messages that occurred during provisioning. | [required] +**warnings** | **[]str** | A list of any accumulated warning messages that occurred during provisioning. | [required] +**stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] +**identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional] +**campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] +**certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] +**tracking_number** | **str** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**sources** | **str** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**action** | **str** | Origin of where the provisioning request came from. | [optional] +**recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] +**file_name** | **str** | A name for the report file. | [required] +**owner_email** | **str** | The email address of the identity that owns the saved search. | [required] +**owner_name** | **str** | The name of the identity that owns the saved search. | [required] +**query** | **str** | The search query that was used to generate the report. | [required] +**search_name** | **str** | The name of the saved search. | [required] +**search_results** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**signed_s3_url** | **str** | The Amazon S3 URL to download the report from. | [required] +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | The unique ID of the source. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**name** | **str** | The user friendly name of the source. | [required] +**type** | **str** | The connection type of the source. | [required] +**created** | **datetime** | The date and time the status change occurred. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] +**deleted** | **datetime** | The date and time the source was deleted. | [required] +**modified** | **datetime** | The date and time the source was modified. | [required] +**application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**health_check_result** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**previous_health_check_result** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.trigger_example_input import TriggerExampleInput + +trigger_example_input = TriggerExampleInput( +access_request_id='2c91808b6ef1d43e016efba0ce470904', +requested_for=[ + sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items=[ + sailpoint.beta.models.access_request_pre_approval_requested_items_inner.AccessRequestPreApproval_requestedItems_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', ) + ], +requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_items_status=[ + sailpoint.beta.models.access_request_post_approval_requested_items_status_inner.AccessRequestPostApproval_requestedItemsStatus_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', + client_metadata = {applicationName=My application}, + approval_info = [ + sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner( + approval_comment = 'This access looks good. Approved.', + approval_decision = APPROVED, + approver_name = 'Stephen.Austin', + approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ), ) + ], ) + ], +source=sailpoint.beta.models.account_uncorrelated_source.AccountUncorrelated_source( + type = 'SOURCE', + id = '2c6180835d191a86015d28455b4b231b', + name = 'Corporate Directory', ), +status=Success, +started='2020-06-29T22:01:50.474Z', +completed='2020-06-29T22:02:04.090Z', +errors=[ + 'Connector AD Failed' + ], +warnings=[ + 'Notification Skipped due to invalid email' + ], +stats=sailpoint.beta.models.accounts_collected_for_aggregation_stats.AccountsCollectedForAggregation_stats( + scanned = 200, + unchanged = 190, + changed = 6, + added = 4, + removed = 3, ), +identity=sailpoint.beta.models.identity_deleted_identity.IdentityDeleted_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +account=sailpoint.beta.models.account_uncorrelated_account.AccountUncorrelated_account( + type = ACCOUNT, + id = '4dd497e3723e439991cb6d0e478375dd', + name = 'Sadie Jensen', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ), +changes=[ + sailpoint.beta.models.identity_attributes_changed_changes_inner.IdentityAttributesChanged_changes_inner( + attribute = 'department', + old_value = sales, + new_value = marketing, ) + ], +attributes={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}, +entitlement_count=0, +campaign=sailpoint.beta.models.campaign_generated_campaign.CampaignGenerated_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-02-17T03:04:45.815Z', + deadline = '2021-02-18T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.beta.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = STAGED, ), +certification=sailpoint.beta.models.certification_signed_off_certification.CertificationSignedOff_certification( + id = '2c91808576f886190176f88caf0d0067', + name = 'Manager Access Review for Alice Baker', + created = '2020-02-16T03:04:45.815Z', + modified = '2020-02-16T03:06:45.815Z', ), +tracking_number='4b4d982dddff4267ab12f0f1e72b5a6d', +sources='Corp AD, Corp LDAP, Corp Salesforce', +action='IdentityRefresh', +recipient=sailpoint.beta.models.provisioning_completed_recipient.ProvisioningCompleted_recipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +requester=sailpoint.beta.models.provisioning_completed_requester.ProvisioningCompleted_requester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +account_requests=[ + sailpoint.beta.models.provisioning_completed_account_requests_inner.ProvisioningCompleted_accountRequests_inner( + source = sailpoint.beta.models.provisioning_completed_account_requests_inner_source.ProvisioningCompleted_accountRequests_inner_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), + account_id = 'CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com', + account_operation = 'Modify', + provisioning_result = SUCCESS, + provisioning_target = 'Corp AD', + ticket_id = '72619262', + attribute_requests = [ + sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner( + attribute_name = 'memberOf', + attribute_value = 'CN=jedi,DC=starwars,DC=com', + operation = Add, ) + ], ) + ], +file_name='Modified.zip', +owner_email='test@sailpoint.com', +owner_name='Cloud Support', +query='modified:[now-7y/d TO now]', +search_name='Modified Activity', +search_results=sailpoint.beta.models.saved_search_complete_search_results.SavedSearchComplete_searchResults( + account = sailpoint.beta.models.saved_search_complete_search_results_account.SavedSearchComplete_searchResults_Account( + count = '3', + noun = 'accounts', + preview = [ + [] + ], ), + entitlement = sailpoint.beta.models.saved_search_complete_search_results_entitlement.SavedSearchComplete_searchResults_Entitlement( + count = '2', + noun = 'entitlements', + preview = [ + [] + ], ), + identity = sailpoint.beta.models.saved_search_complete_search_results_identity.SavedSearchComplete_searchResults_Identity( + count = '2', + noun = 'identities', + preview = [ + [] + ], ), ), +signed_s3_url='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', +uuid='b7264868-7201-415f-9118-b581d431c688', +id='2c9180866166b5b0016167c32ef31a66', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +name='Corporate Active Directory', +type='DIRECT_CONNECT', +created='2020-06-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.beta.models.source_updated_actor.SourceUpdated_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +deleted='2021-03-29T22:01:50.474Z', +modified='2021-03-29T22:01:50.474Z', +application=sailpoint.beta.models.va_cluster_status_change_event_application.VAClusterStatusChangeEvent_application( + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Production VA Cluster', + attributes = { }, ), +health_check_result=sailpoint.beta.models.va_cluster_status_change_event_health_check_result.VAClusterStatusChangeEvent_healthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Succeeded, ), +previous_health_check_result=sailpoint.beta.models.va_cluster_status_change_event_previous_health_check_result.VAClusterStatusChangeEvent_previousHealthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Failed, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleOutput.md b/docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..37b62dc23 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleOutput.md @@ -0,0 +1,44 @@ +--- +id: beta-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TriggerExampleOutput', 'BetaTriggerExampleOutput'] +slug: /tools/sdk/python/beta/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'BetaTriggerExampleOutput'] +--- + +# TriggerExampleOutput + +An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity to add to the approver list for the access request. | [required] +**name** | **str** | The name of the identity to add to the approver list for the access request. | [required] +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The type of object being referenced. | [required] +**approved** | **bool** | Whether or not to approve the access request. | [required] +**comment** | **str** | A comment about the decision to approve or deny the request. | [required] +**approver** | **str** | The name of the entity that approved or denied the request. | [required] +} + +## Example + +```python +from sailpoint.beta.models.trigger_example_output import TriggerExampleOutput + +trigger_example_output = TriggerExampleOutput( +id='2c91808b6ef1d43e016efba0ce470906', +name='Adam Adams', +type=IDENTITY, +approved=False, +comment='This access should be denied, because this will cause an SOD violation.', +approver='AcmeCorpExternalIntegration' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/TriggerType.md b/docs/tools/sdk/python/Reference/Beta/Models/TriggerType.md new file mode 100644 index 000000000..4b5e8d103 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/TriggerType.md @@ -0,0 +1,23 @@ +--- +id: beta-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TriggerType', 'BetaTriggerType'] +slug: /tools/sdk/python/beta/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'BetaTriggerType'] +--- + +# TriggerType + +The type of trigger. + +## Enum + +* `REQUEST_RESPONSE` (value: `'REQUEST_RESPONSE'`) + +* `FIRE_AND_FORGET` (value: `'FIRE_AND_FORGET'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/python/Reference/Beta/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..2d23ede86 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,33 @@ +--- +id: beta-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'BetaUpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/python/beta/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'BetaUpdateAccessProfilesInBulk412Response'] +--- + +# UpdateAccessProfilesInBulk412Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.beta.models.update_access_profiles_in_bulk412_response import UpdateAccessProfilesInBulk412Response + +update_access_profiles_in_bulk412_response = UpdateAccessProfilesInBulk412Response( +message= API/Feature not enabled for your organization. +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UpdateMultiHostSourcesRequestInner.md b/docs/tools/sdk/python/Reference/Beta/Models/UpdateMultiHostSourcesRequestInner.md new file mode 100644 index 000000000..68b5cc4e1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UpdateMultiHostSourcesRequestInner.md @@ -0,0 +1,38 @@ +--- +id: beta-update-multi-host-sources-request-inner +title: UpdateMultiHostSourcesRequestInner +pagination_label: UpdateMultiHostSourcesRequestInner +sidebar_label: UpdateMultiHostSourcesRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'BetaUpdateMultiHostSourcesRequestInner'] +slug: /tools/sdk/python/beta/models/update-multi-host-sources-request-inner +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'BetaUpdateMultiHostSourcesRequestInner'] +--- + +# UpdateMultiHostSourcesRequestInner + +A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'replace' ] | The operation to be performed | [required] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner + +update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UpdateMultiHostSourcesRequestInnerValue.md b/docs/tools/sdk/python/Reference/Beta/Models/UpdateMultiHostSourcesRequestInnerValue.md new file mode 100644 index 000000000..cbbd68eae --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UpdateMultiHostSourcesRequestInnerValue.md @@ -0,0 +1,32 @@ +--- +id: beta-update-multi-host-sources-request-inner-value +title: UpdateMultiHostSourcesRequestInnerValue +pagination_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'BetaUpdateMultiHostSourcesRequestInnerValue'] +slug: /tools/sdk/python/beta/models/update-multi-host-sources-request-inner-value +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'BetaUpdateMultiHostSourcesRequestInnerValue'] +--- + +# UpdateMultiHostSourcesRequestInnerValue + +The value to be used for the operation, required for \"add\" and \"replace\" operations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.update_multi_host_sources_request_inner_value import UpdateMultiHostSourcesRequestInnerValue + +update_multi_host_sources_request_inner_value = UpdateMultiHostSourcesRequestInnerValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UsageType.md b/docs/tools/sdk/python/Reference/Beta/Models/UsageType.md new file mode 100644 index 000000000..fead9acf4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UsageType.md @@ -0,0 +1,51 @@ +--- +id: beta-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UsageType', 'BetaUsageType'] +slug: /tools/sdk/python/beta/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'BetaUsageType'] +--- + +# 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. + +## Enum + +* `CREATE` (value: `'CREATE'`) + +* `UPDATE` (value: `'UPDATE'`) + +* `ENABLE` (value: `'ENABLE'`) + +* `DISABLE` (value: `'DISABLE'`) + +* `DELETE` (value: `'DELETE'`) + +* `ASSIGN` (value: `'ASSIGN'`) + +* `UNASSIGN` (value: `'UNASSIGN'`) + +* `CREATE_GROUP` (value: `'CREATE_GROUP'`) + +* `UPDATE_GROUP` (value: `'UPDATE_GROUP'`) + +* `DELETE_GROUP` (value: `'DELETE_GROUP'`) + +* `REGISTER` (value: `'REGISTER'`) + +* `CREATE_IDENTITY` (value: `'CREATE_IDENTITY'`) + +* `UPDATE_IDENTITY` (value: `'UPDATE_IDENTITY'`) + +* `EDIT_GROUP` (value: `'EDIT_GROUP'`) + +* `UNLOCK` (value: `'UNLOCK'`) + +* `CHANGE_PASSWORD` (value: `'CHANGE_PASSWORD'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UserApp.md b/docs/tools/sdk/python/Reference/Beta/Models/UserApp.md new file mode 100644 index 000000000..44e4c0db2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UserApp.md @@ -0,0 +1,66 @@ +--- +id: beta-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserApp', 'BetaUserApp'] +slug: /tools/sdk/python/beta/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'BetaUserApp'] +--- + +# UserApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The user app id | [optional] +**created** | **datetime** | Time when the user app was created | [optional] +**modified** | **datetime** | Time when the user app was last modified | [optional] +**has_multiple_accounts** | **bool** | True if the owner has multiple accounts for the source | [optional] [default to False] +**use_for_password_management** | **bool** | True if the source has password feature | [optional] [default to False] +**provision_request_enabled** | **bool** | True if the source app related to the user app is provision request enabled | [optional] [default to False] +**app_center_enabled** | **bool** | True if the source app related to the user app is shown in the app center | [optional] [default to True] +**source_app** | [**UserAppSourceApp**](user-app-source-app) | | [optional] +**source** | [**UserAppSource**](user-app-source) | | [optional] +**account** | [**UserAppAccount**](user-app-account) | | [optional] +**owner** | [**UserAppOwner**](user-app-owner) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.user_app import UserApp + +user_app = UserApp( +id='2c91808874ff91550175097daaec161c', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +has_multiple_accounts=False, +use_for_password_management=True, +provision_request_enabled=True, +app_center_enabled=True, +source_app=sailpoint.beta.models.user_app_source_app.UserApp_sourceApp( + id = 'edcb0951812949d085b60cd8bf35bc78', + type = 'APPLICATION', + name = 'test-app', ), +source=sailpoint.beta.models.user_app_source.UserApp_source( + id = '9870808a7190d06e01719938fcd20792', + type = 'SOURCE', + name = 'test-source', ), +account=sailpoint.beta.models.user_app_account.UserApp_account( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'ACCOUNT', + name = 'test account', ), +owner=sailpoint.beta.models.user_app_owner.UserApp_owner( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'IDENTITY', + name = 'John', + alias = 'John.Doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UserAppAccount.md b/docs/tools/sdk/python/Reference/Beta/Models/UserAppAccount.md new file mode 100644 index 000000000..80b1e4857 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UserAppAccount.md @@ -0,0 +1,37 @@ +--- +id: beta-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppAccount', 'BetaUserAppAccount'] +slug: /tools/sdk/python/beta/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'BetaUserAppAccount'] +--- + +# UserAppAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the account ID | [optional] +**type** | **str** | It will always be \"ACCOUNT\" | [optional] +**name** | **str** | the account name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.user_app_account import UserAppAccount + +user_app_account = UserAppAccount( +id='85d173e7d57e496569df763231d6deb6a', +type='ACCOUNT', +name='test account' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UserAppOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/UserAppOwner.md new file mode 100644 index 000000000..743ed1ba1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UserAppOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppOwner', 'BetaUserAppOwner'] +slug: /tools/sdk/python/beta/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'BetaUserAppOwner'] +--- + +# UserAppOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**type** | **str** | It will always be \"IDENTITY\" | [optional] +**name** | **str** | The identity name | [optional] +**alias** | **str** | The identity alias | [optional] +} + +## Example + +```python +from sailpoint.beta.models.user_app_owner import UserAppOwner + +user_app_owner = UserAppOwner( +id='2c9180827ca885d7017ca8ce28a000eb', +type='IDENTITY', +name='John', +alias='John.Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UserAppSource.md b/docs/tools/sdk/python/Reference/Beta/Models/UserAppSource.md new file mode 100644 index 000000000..d2b3f3b75 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UserAppSource.md @@ -0,0 +1,37 @@ +--- +id: beta-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppSource', 'BetaUserAppSource'] +slug: /tools/sdk/python/beta/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'BetaUserAppSource'] +--- + +# UserAppSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the source ID | [optional] +**type** | **str** | It will always be \"SOURCE\" | [optional] +**name** | **str** | the source name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.user_app_source import UserAppSource + +user_app_source = UserAppSource( +id='9870808a7190d06e01719938fcd20792', +type='SOURCE', +name='test-source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/UserAppSourceApp.md b/docs/tools/sdk/python/Reference/Beta/Models/UserAppSourceApp.md new file mode 100644 index 000000000..10e8b6eba --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/UserAppSourceApp.md @@ -0,0 +1,37 @@ +--- +id: beta-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppSourceApp', 'BetaUserAppSourceApp'] +slug: /tools/sdk/python/beta/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'BetaUserAppSourceApp'] +--- + +# UserAppSourceApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the source app ID | [optional] +**type** | **str** | It will always be \"APPLICATION\" | [optional] +**name** | **str** | the source app name | [optional] +} + +## Example + +```python +from sailpoint.beta.models.user_app_source_app import UserAppSourceApp + +user_app_source_app = UserAppSourceApp( +id='edcb0951812949d085b60cd8bf35bc78', +type='APPLICATION', +name='test-app' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/V3ConnectorDto.md b/docs/tools/sdk/python/Reference/Beta/Models/V3ConnectorDto.md new file mode 100644 index 000000000..368549735 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/V3ConnectorDto.md @@ -0,0 +1,47 @@ +--- +id: beta-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'V3ConnectorDto', 'BetaV3ConnectorDto'] +slug: /tools/sdk/python/beta/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'BetaV3ConnectorDto'] +--- + +# V3ConnectorDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The connector name | [optional] +**type** | **str** | The connector type | [optional] +**script_name** | **str** | The connector script name | [optional] +**class_name** | **str** | The connector class name. | [optional] +**features** | **[]str** | The list of features supported by the connector | [optional] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to False] +**connector_metadata** | **object** | Object containing metadata pertinent to the UI to be used | [optional] +**status** | **str** | The connector status | [optional] +} + +## Example + +```python +from sailpoint.beta.models.v3_connector_dto import V3ConnectorDto + +v3_connector_dto = V3ConnectorDto( +name='name', +type='ServiceNow', +script_name='servicenow', +class_name='sailpoint.connector.OpenConnectorAdapter', +features=[PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS], +direct_connect=True, +connector_metadata={supportedUI=EXTJS, platform=ccg, shortDesc=connector description}, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..8beb904a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,50 @@ +--- +id: beta-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEvent', 'BetaVAClusterStatusChangeEvent'] +slug: /tools/sdk/python/beta/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'BetaVAClusterStatusChangeEvent'] +--- + +# VAClusterStatusChangeEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | The date and time the status change occurred. | [required] +**type** | **Enum** [ 'SOURCE', 'CLUSTER' ] | The type of the object that initiated this event. | [required] +**application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**health_check_result** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**previous_health_check_result** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.va_cluster_status_change_event import VAClusterStatusChangeEvent + +va_cluster_status_change_event = VAClusterStatusChangeEvent( +created='2020-06-29T22:01:50.474Z', +type=CLUSTER, +application=sailpoint.beta.models.va_cluster_status_change_event_application.VAClusterStatusChangeEvent_application( + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Production VA Cluster', + attributes = { }, ), +health_check_result=sailpoint.beta.models.va_cluster_status_change_event_health_check_result.VAClusterStatusChangeEvent_healthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Succeeded, ), +previous_health_check_result=sailpoint.beta.models.va_cluster_status_change_event_previous_health_check_result.VAClusterStatusChangeEvent_previousHealthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Failed, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..acb0f99b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,38 @@ +--- +id: beta-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEventApplication', 'BetaVAClusterStatusChangeEventApplication'] +slug: /tools/sdk/python/beta/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'BetaVAClusterStatusChangeEventApplication'] +--- + +# VAClusterStatusChangeEventApplication + +Details about the `CLUSTER` or `SOURCE` that initiated this event. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The GUID of the application | [required] +**name** | **str** | The name of the application | [required] +**attributes** | **map[string]object** | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required] +} + +## Example + +```python +from sailpoint.beta.models.va_cluster_status_change_event_application import VAClusterStatusChangeEventApplication + +va_cluster_status_change_event_application = VAClusterStatusChangeEventApplication( +id='2c9180866166b5b0016167c32ef31a66', +name='Production VA Cluster', +attributes={ } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..576cdde8f --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,38 @@ +--- +id: beta-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'BetaVAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/python/beta/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'BetaVAClusterStatusChangeEventHealthCheckResult'] +--- + +# VAClusterStatusChangeEventHealthCheckResult + +The results of the most recent health check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Detailed message of the result of the health check. | [required] +**result_type** | **str** | The type of the health check result. | [required] +**status** | **Enum** [ 'Succeeded', 'Failed' ] | The status of the health check. | [required] +} + +## Example + +```python +from sailpoint.beta.models.va_cluster_status_change_event_health_check_result import VAClusterStatusChangeEventHealthCheckResult + +va_cluster_status_change_event_health_check_result = VAClusterStatusChangeEventHealthCheckResult( +message='Test Connection failed with exception. Error message - java.lang Exception', +result_type='SOURCE_STATE_ERROR_CLUSTER', +status=Succeeded +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..9351c0a93 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,38 @@ +--- +id: beta-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'BetaVAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/python/beta/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'BetaVAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +The results of the last health check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Detailed message of the result of the health check. | [required] +**result_type** | **str** | The type of the health check result. | [required] +**status** | **Enum** [ 'Succeeded', 'Failed' ] | The status of the health check. | [required] +} + +## Example + +```python +from sailpoint.beta.models.va_cluster_status_change_event_previous_health_check_result import VAClusterStatusChangeEventPreviousHealthCheckResult + +va_cluster_status_change_event_previous_health_check_result = VAClusterStatusChangeEventPreviousHealthCheckResult( +message='Test Connection failed with exception. Error message - java.lang Exception', +result_type='SOURCE_STATE_ERROR_CLUSTER', +status=Failed +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ValidateFilterInputDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..38fdbcd6d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ValidateFilterInputDto.md @@ -0,0 +1,35 @@ +--- +id: beta-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ValidateFilterInputDto', 'BetaValidateFilterInputDto'] +slug: /tools/sdk/python/beta/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'BetaValidateFilterInputDto'] +--- + +# ValidateFilterInputDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | Mock input to evaluate filter expression against. | [required] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [required] +} + +## Example + +```python +from sailpoint.beta.models.validate_filter_input_dto import ValidateFilterInputDto + +validate_filter_input_dto = ValidateFilterInputDto( +input={identityId=201327fda1c44704ac01181e963d463c}, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/python/Reference/Beta/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..e1c0547c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ValidateFilterOutputDto.md @@ -0,0 +1,37 @@ +--- +id: beta-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ValidateFilterOutputDto', 'BetaValidateFilterOutputDto'] +slug: /tools/sdk/python/beta/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'BetaValidateFilterOutputDto'] +--- + +# ValidateFilterOutputDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**is_valid** | **bool** | When this field is true, the filter expression is valid against the input. | [optional] [default to False] +**is_valid_json_path** | **bool** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to False] +**is_path_exist** | **bool** | When this field is true, the filter expression is using an existing path. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.validate_filter_output_dto import ValidateFilterOutputDto + +validate_filter_output_dto = ValidateFilterOutputDto( +is_valid=True, +is_valid_json_path=True, +is_path_exist=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Value.md b/docs/tools/sdk/python/Reference/Beta/Models/Value.md new file mode 100644 index 000000000..b2538f49b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Value.md @@ -0,0 +1,35 @@ +--- +id: beta-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Value', 'BetaValue'] +slug: /tools/sdk/python/beta/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'BetaValue'] +--- + +# Value + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of attribute value | [optional] +**value** | **str** | The attribute value | [optional] +} + +## Example + +```python +from sailpoint.beta.models.value import Value + +value = Value( +type='STRING', +value='Austin' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMapping.md b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..a88716d67 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMapping.md @@ -0,0 +1,57 @@ +--- +id: beta-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMapping', 'BetaVendorConnectorMapping'] +slug: /tools/sdk/python/beta/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'BetaVendorConnectorMapping'] +--- + +# VendorConnectorMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier for the vendor-connector mapping. | [optional] +**vendor** | **str** | The name of the vendor. | [optional] +**connector** | **str** | The name of the connector. | [optional] +**created_at** | **datetime** | The creation timestamp of the mapping. | [optional] +**created_by** | **str** | The identifier of the user who created the mapping. | [optional] +**updated_at** | [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**updated_by** | [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**deleted_at** | [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**deleted_by** | [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping + +vendor_connector_mapping = VendorConnectorMapping( +id='78733556-9ea3-4f59-bf69-e5cd92b011b4', +vendor='Example vendor', +connector='Example connector', +created_at='2024-03-13T12:56:19.391294Z', +created_by='admin', +updated_at=sailpoint.beta.models.vendor_connector_mapping_updated_at.VendorConnectorMapping_updatedAt( + time = '2024-03-14T12:56:19.391294Z', + valid = True, ), +updated_by=sailpoint.beta.models.vendor_connector_mapping_updated_by.VendorConnectorMapping_updatedBy( + string = 'user-67891', + valid = True, ), +deleted_at=sailpoint.beta.models.vendor_connector_mapping_deleted_at.VendorConnectorMapping_deletedAt( + time = '0001-01-01T00:00Z', + valid = False, ), +deleted_by=sailpoint.beta.models.vendor_connector_mapping_deleted_by.VendorConnectorMapping_deletedBy( + string = '', + valid = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..b5c5a2b92 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,36 @@ +--- +id: beta-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingDeletedAt', 'BetaVendorConnectorMappingDeletedAt'] +slug: /tools/sdk/python/beta/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'BetaVendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +An object representing the nullable timestamp of when the mapping was deleted. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**valid** | **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.vendor_connector_mapping_deleted_at import VendorConnectorMappingDeletedAt + +vendor_connector_mapping_deleted_at = VendorConnectorMappingDeletedAt( +time='0001-01-01T00:00Z', +valid=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..a22f3a017 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,36 @@ +--- +id: beta-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingDeletedBy', 'BetaVendorConnectorMappingDeletedBy'] +slug: /tools/sdk/python/beta/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'BetaVendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +An object representing the nullable identifier of the user who deleted the mapping. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**string** | **str** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**valid** | **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.vendor_connector_mapping_deleted_by import VendorConnectorMappingDeletedBy + +vendor_connector_mapping_deleted_by = VendorConnectorMappingDeletedBy( +string='', +valid=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..34799feaa --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,36 @@ +--- +id: beta-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingUpdatedAt', 'BetaVendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/python/beta/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'BetaVendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +An object representing the nullable timestamp of the last update. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**valid** | **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.vendor_connector_mapping_updated_at import VendorConnectorMappingUpdatedAt + +vendor_connector_mapping_updated_at = VendorConnectorMappingUpdatedAt( +time='2024-03-14T12:56:19.391294Z', +valid=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..2558fe49c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,36 @@ +--- +id: beta-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingUpdatedBy', 'BetaVendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/python/beta/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'BetaVendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +An object representing the nullable identifier of the user who last updated the mapping. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**string** | **str** | The identifier of the user who last updated the mapping, if available. | [optional] +**valid** | **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.beta.models.vendor_connector_mapping_updated_by import VendorConnectorMappingUpdatedBy + +vendor_connector_mapping_updated_by = VendorConnectorMappingUpdatedBy( +string='user-67891', +valid=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VerificationPollRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/VerificationPollRequest.md new file mode 100644 index 000000000..ff65c6e98 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VerificationPollRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-verification-poll-request +title: VerificationPollRequest +pagination_label: VerificationPollRequest +sidebar_label: VerificationPollRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VerificationPollRequest', 'BetaVerificationPollRequest'] +slug: /tools/sdk/python/beta/models/verification-poll-request +tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest', 'BetaVerificationPollRequest'] +--- + +# VerificationPollRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | Verification request Id | [required] +} + +## Example + +```python +from sailpoint.beta.models.verification_poll_request import VerificationPollRequest + +verification_poll_request = VerificationPollRequest( +request_id='089899f13a8f4da7824996191587bab9' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/VerificationResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/VerificationResponse.md new file mode 100644 index 000000000..ca4092ef5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VerificationResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-verification-response +title: VerificationResponse +pagination_label: VerificationResponse +sidebar_label: VerificationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VerificationResponse', 'BetaVerificationResponse'] +slug: /tools/sdk/python/beta/models/verification-response +tags: ['SDK', 'Software Development Kit', 'VerificationResponse', 'BetaVerificationResponse'] +--- + +# VerificationResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The verificationPollRequest request ID | [optional] +**status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED', 'LOCKOUT', 'NOT_ENOUGH_DATA' ] | MFA Authentication status | [optional] +**error** | **str** | Error messages from MFA verification request | [optional] +} + +## Example + +```python +from sailpoint.beta.models.verification_response import VerificationResponse + +verification_response = VerificationResponse( +request_id='089899f13a8f4da7824996191587bab9', +status='SUCCESS', +error='Unable to connect DUO Service during verification' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ViolationContext.md b/docs/tools/sdk/python/Reference/Beta/Models/ViolationContext.md new file mode 100644 index 000000000..7aeb5692b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ViolationContext.md @@ -0,0 +1,40 @@ +--- +id: beta-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationContext', 'BetaViolationContext'] +slug: /tools/sdk/python/beta/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'BetaViolationContext'] +--- + +# ViolationContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**conflicting_access_criteria** | [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.violation_context import ViolationContext + +violation_context = ViolationContext( +policy=sailpoint.beta.models.violation_context_policy.ViolationContext_policy( + type = ENTITLEMENT, ), +conflicting_access_criteria=sailpoint.beta.models.exception_access_criteria.ExceptionAccessCriteria( + left_criteria = sailpoint.beta.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ), + right_criteria = sailpoint.beta.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/Beta/Models/ViolationContextPolicy.md b/docs/tools/sdk/python/Reference/Beta/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..c47780278 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ViolationContextPolicy.md @@ -0,0 +1,38 @@ +--- +id: beta-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationContextPolicy', 'BetaViolationContextPolicy'] +slug: /tools/sdk/python/beta/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'BetaViolationContextPolicy'] +--- + +# ViolationContextPolicy + +The types of objects supported for SOD policy violations. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | The type of object supported for SOD policy violations. | [optional] +**id** | **str** | SOD policy ID. | [optional] +**name** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.violation_context_policy import ViolationContextPolicy + +violation_context_policy = ViolationContextPolicy( +type=ENTITLEMENT, +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='A very cool policy name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/python/Reference/Beta/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..b81b8959d --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,38 @@ +--- +id: beta-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationOwnerAssignmentConfig', 'BetaViolationOwnerAssignmentConfig'] +slug: /tools/sdk/python/beta/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'BetaViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignment_rule** | **Enum** [ 'MANAGER', 'STATIC' ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**owner_ref** | [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.violation_owner_assignment_config import ViolationOwnerAssignmentConfig + +violation_owner_assignment_config = ViolationOwnerAssignmentConfig( +assignment_rule='MANAGER', +owner_ref=sailpoint.beta.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/python/Reference/Beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..6448b02b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,38 @@ +--- +id: beta-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'BetaViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/python/beta/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'BetaViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +The owner of the violation assignment config. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP', 'MANAGER' ] | Owner type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.violation_owner_assignment_config_owner_ref import ViolationOwnerAssignmentConfigOwnerRef + +violation_owner_assignment_config_owner_ref = ViolationOwnerAssignmentConfigOwnerRef( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ViolationPrediction.md b/docs/tools/sdk/python/Reference/Beta/Models/ViolationPrediction.md new file mode 100644 index 000000000..7e3b26990 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/ViolationPrediction.md @@ -0,0 +1,43 @@ +--- +id: beta-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationPrediction', 'BetaViolationPrediction'] +slug: /tools/sdk/python/beta/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'BetaViolationPrediction'] +--- + +# ViolationPrediction + +An object containing a listing of the SOD violation reasons detected by this check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**violation_contexts** | [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] +} + +## Example + +```python +from sailpoint.beta.models.violation_prediction import ViolationPrediction + +violation_prediction = ViolationPrediction( +violation_contexts=[ + sailpoint.beta.models.violation_context.ViolationContext( + policy = sailpoint.beta.models.violation_context_policy.ViolationContext_policy( + type = ENTITLEMENT, ), + conflicting_access_criteria = sailpoint.beta.models.exception_access_criteria.ExceptionAccessCriteria( + left_criteria = sailpoint.beta.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ), + right_criteria = sailpoint.beta.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/Beta/Models/VisibilityCriteria.md b/docs/tools/sdk/python/Reference/Beta/Models/VisibilityCriteria.md new file mode 100644 index 000000000..b96ee4404 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/VisibilityCriteria.md @@ -0,0 +1,38 @@ +--- +id: beta-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VisibilityCriteria', 'BetaVisibilityCriteria'] +slug: /tools/sdk/python/beta/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'BetaVisibilityCriteria'] +--- + +# VisibilityCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | [**Expression**](expression) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.visibility_criteria import VisibilityCriteria + +visibility_criteria = VisibilityCriteria( +expression=sailpoint.beta.models.expression.Expression( + operator = 'EQUALS', + attribute = 'location', + value = sailpoint.beta.models.value.Value( + type = 'STRING', ), + children = [], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkItemForward.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemForward.md new file mode 100644 index 000000000..a6079ef96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemForward.md @@ -0,0 +1,37 @@ +--- +id: beta-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemForward', 'BetaWorkItemForward'] +slug: /tools/sdk/python/beta/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'BetaWorkItemForward'] +--- + +# WorkItemForward + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_owner_id** | **str** | The ID of the identity to forward this work item to. | [required] +**comment** | **str** | Comments to send to the target owner | [required] +**send_notifications** | **bool** | If true, send a notification to the target owner. | [optional] [default to True] +} + +## Example + +```python +from sailpoint.beta.models.work_item_forward import WorkItemForward + +work_item_forward = WorkItemForward( +target_owner_id='2c9180835d2e5168015d32f890ca1581', +comment='I'm going on vacation.', +send_notifications=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkItemState.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemState.md new file mode 100644 index 000000000..5271fefdc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemState.md @@ -0,0 +1,31 @@ +--- +id: beta-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemState', 'BetaWorkItemState'] +slug: /tools/sdk/python/beta/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'BetaWorkItemState'] +--- + +# WorkItemState + +The state of a work item + +## Enum + +* `FINISHED` (value: `'Finished'`) + +* `REJECTED` (value: `'Rejected'`) + +* `RETURNED` (value: `'Returned'`) + +* `EXPIRED` (value: `'Expired'`) + +* `PENDING` (value: `'Pending'`) + +* `CANCELED` (value: `'Canceled'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkItemType.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemType.md new file mode 100644 index 000000000..65c3a2b77 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemType.md @@ -0,0 +1,49 @@ +--- +id: beta-work-item-type +title: WorkItemType +pagination_label: WorkItemType +sidebar_label: WorkItemType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemType', 'BetaWorkItemType'] +slug: /tools/sdk/python/beta/models/work-item-type +tags: ['SDK', 'Software Development Kit', 'WorkItemType', 'BetaWorkItemType'] +--- + +# WorkItemType + +The type of the work item + +## Enum + +* `UNKNOWN` (value: `'Unknown'`) + +* `GENERIC` (value: `'Generic'`) + +* `CERTIFICATION` (value: `'Certification'`) + +* `REMEDIATION` (value: `'Remediation'`) + +* `DELEGATION` (value: `'Delegation'`) + +* `APPROVAL` (value: `'Approval'`) + +* `VIOLATIONREVIEW` (value: `'ViolationReview'`) + +* `FORM` (value: `'Form'`) + +* `POLICYVIOLATION` (value: `'PolicyViolation'`) + +* `CHALLENGE` (value: `'Challenge'`) + +* `IMPACTANALYSIS` (value: `'ImpactAnalysis'`) + +* `SIGNOFF` (value: `'Signoff'`) + +* `EVENT` (value: `'Event'`) + +* `MANUALACTION` (value: `'ManualAction'`) + +* `TEST` (value: `'Test'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkItems.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkItems.md new file mode 100644 index 000000000..306ea3e54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkItems.md @@ -0,0 +1,93 @@ +--- +id: beta-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItems', 'BetaWorkItems'] +slug: /tools/sdk/python/beta/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems'] +--- + +# WorkItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the work item | [optional] +**requester_id** | **str** | ID of the requester | [optional] +**requester_display_name** | **str** | The displayname of the requester | [optional] +**owner_id** | **str** | The ID of the owner | [optional] +**owner_name** | **str** | The name of the owner | [optional] +**created** | **datetime** | | [optional] +**modified** | **datetime** | | [optional] +**description** | **str** | The description of the work item | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +**type** | [**WorkItemType**](work-item-type) | | [optional] +**remediation_items** | [**[]RemediationItemDetails**](remediation-item-details) | | [optional] +**approval_items** | [**[]ApprovalItemDetails**](approval-item-details) | | [optional] +**name** | **str** | The work item name | [optional] +**completed** | **datetime** | | [optional] +**num_items** | **int** | The number of items in the work item | [optional] +**errors** | **[]str** | | [optional] +**form** | [**FormDetails**](form-details) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.work_items import WorkItems + +work_items = WorkItems( +id='2c9180835d2e5168015d32f890ca1581', +requester_id='2c9180835d2e5168015d32f890ca1581', +requester_display_name='John Smith', +owner_id='2c9180835d2e5168015d32f890ca1581', +owner_name='Jason Smith', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +description='Create account on source 'AD'', +state='Pending', +type='Generic', +remediation_items=[ + sailpoint.beta.models.remediation_item_details.RemediationItemDetails( + id = '2c9180835d2e5168015d32f890ca1581', + target_id = '2c9180835d2e5168015d32f890ca1581', + target_name = 'john.smith', + target_display_name = 'emailAddress', + application_name = 'Active Directory', + attribute_name = 'phoneNumber', + attribute_operation = 'update', + attribute_value = '512-555-1212', + native_identity = 'jason.smith2', ) + ], +approval_items=[ + sailpoint.beta.models.approval_item_details.ApprovalItemDetails( + id = '2c9180835d2e5168015d32f890ca1581', + account = 'john.smith', + application = 'Active Directory', + name = 'emailAddress', + operation = 'update', + value = 'a@b.com', + state = 'Pending', ) + ], +name='Account Create', +completed='2018-10-19T13:49:37.385Z', +num_items=19, +errors=[The work item ID that was specified was not found.], +form=sailpoint.beta.models.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.beta.models.section_details.SectionDetails() + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkItemsCount.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemsCount.md new file mode 100644 index 000000000..ec70de1b3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemsCount.md @@ -0,0 +1,33 @@ +--- +id: beta-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsCount', 'BetaWorkItemsCount'] +slug: /tools/sdk/python/beta/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'BetaWorkItemsCount'] +--- + +# WorkItemsCount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | The count of work items | [optional] +} + +## Example + +```python +from sailpoint.beta.models.work_items_count import WorkItemsCount + +work_items_count = WorkItemsCount( +count=29 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkItemsSummary.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemsSummary.md new file mode 100644 index 000000000..09b07eba5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkItemsSummary.md @@ -0,0 +1,37 @@ +--- +id: beta-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsSummary', 'BetaWorkItemsSummary'] +slug: /tools/sdk/python/beta/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'BetaWorkItemsSummary'] +--- + +# WorkItemsSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**open** | **int** | The count of open work items | [optional] +**completed** | **int** | The count of completed work items | [optional] +**total** | **int** | The count of total work items | [optional] +} + +## Example + +```python +from sailpoint.beta.models.work_items_summary import WorkItemsSummary + +work_items_summary = WorkItemsSummary( +open=29, +completed=1, +total=30 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Workflow.md b/docs/tools/sdk/python/Reference/Beta/Models/Workflow.md new file mode 100644 index 000000000..8ac902102 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/Workflow.md @@ -0,0 +1,71 @@ +--- +id: beta-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Workflow', 'BetaWorkflow'] +slug: /tools/sdk/python/beta/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'BetaWorkflow'] +--- + +# Workflow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [optional] +**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] +**id** | **str** | Workflow ID. This is a UUID generated upon creation. | [optional] +**modified** | **datetime** | The date and time the workflow was modified. | [optional] +**modified_by** | [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**execution_count** | **int** | The number of times this workflow has been executed. | [optional] +**failure_count** | **int** | The number of times this workflow has failed during execution. | [optional] +**created** | **datetime** | The date and time the workflow was created. | [optional] +**creator** | [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow import Workflow + +workflow = Workflow( +name='Send Email', +owner=sailpoint.beta.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.beta.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.beta.models.workflow_trigger.WorkflowTrigger( + type = 'EVENT', + display_name = '', + attributes = null, ), +id='d201c5e9-d37b-4aff-af14-66414f39d569', +modified='2023-12-05T15:18:27.699132301Z', +modified_by=sailpoint.beta.models.workflow_modified_by.WorkflowModifiedBy( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ), +execution_count=2, +failure_count=0, +created='2022-01-10T16:06:16.636381447Z', +creator=sailpoint.beta.models.workflow_all_of_creator.Workflow_allOf_creator( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..3fae67753 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowAllOfCreator.md @@ -0,0 +1,38 @@ +--- +id: beta-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowAllOfCreator', 'BetaWorkflowAllOfCreator'] +slug: /tools/sdk/python/beta/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'BetaWorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +Workflow creator's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Workflow creator's DTO type. | [optional] +**id** | **str** | Workflow creator's identity ID. | [optional] +**name** | **str** | Workflow creator's display name. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_all_of_creator import WorkflowAllOfCreator + +workflow_all_of_creator = WorkflowAllOfCreator( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowBody.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowBody.md new file mode 100644 index 000000000..03fb4c364 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowBody.md @@ -0,0 +1,51 @@ +--- +id: beta-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowBody', 'BetaWorkflowBody'] +slug: /tools/sdk/python/beta/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'BetaWorkflowBody'] +--- + +# WorkflowBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [optional] +**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.beta.models.workflow_body import WorkflowBody + +workflow_body = WorkflowBody( +name='Send Email', +owner=sailpoint.beta.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.beta.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.beta.models.workflow_trigger.WorkflowTrigger( + type = 'EVENT', + display_name = '', + attributes = null, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowBodyOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..eeb460506 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowBodyOwner.md @@ -0,0 +1,38 @@ +--- +id: beta-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowBodyOwner', 'BetaWorkflowBodyOwner'] +slug: /tools/sdk/python/beta/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'BetaWorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [optional] +**id** | **str** | The unique ID of the object | [optional] +**name** | **str** | The name of the object | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_body_owner import WorkflowBodyOwner + +workflow_body_owner = WorkflowBodyOwner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowDefinition.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowDefinition.md new file mode 100644 index 000000000..44a4c1d7b --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowDefinition.md @@ -0,0 +1,36 @@ +--- +id: beta-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowDefinition', 'BetaWorkflowDefinition'] +slug: /tools/sdk/python/beta/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'BetaWorkflowDefinition'] +--- + +# WorkflowDefinition + +The map of steps that the workflow will execute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **str** | The name of the starting step. | [optional] +**steps** | **map[string]object** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_definition import WorkflowDefinition + +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}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md new file mode 100644 index 000000000..a59a9e098 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md @@ -0,0 +1,43 @@ +--- +id: beta-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowExecution', 'BetaWorkflowExecution'] +slug: /tools/sdk/python/beta/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'BetaWorkflowExecution'] +--- + +# WorkflowExecution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Workflow execution ID. | [optional] +**workflow_id** | **str** | Workflow ID. | [optional] +**request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**start_time** | **datetime** | Date/time when the workflow started. | [optional] +**close_time** | **datetime** | Date/time when the workflow ended. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_execution import WorkflowExecution + +workflow_execution = WorkflowExecution( +id='b393f4e2-4785-4d7f-ab27-3a6b8ded4c81', +workflow_id='d201c5d9-d37b-4a2f-af14-66414f39d568', +request_id='41e12a74fa7b4a6a98ae47887b64acdb', +start_time='2022-02-07T20:13:29.356648026Z', +close_time='2022-02-07T20:13:31.682410165Z', +status='Completed' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..db60e3536 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecutionEvent.md @@ -0,0 +1,37 @@ +--- +id: beta-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowExecutionEvent', 'BetaWorkflowExecutionEvent'] +slug: /tools/sdk/python/beta/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'BetaWorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WorkflowExecutionScheduled', 'WorkflowExecutionStarted', 'WorkflowExecutionCompleted', 'WorkflowExecutionFailed', 'WorkflowTaskScheduled', 'WorkflowTaskStarted', 'WorkflowTaskCompleted', 'WorkflowTaskFailed', 'ActivityTaskScheduled', 'ActivityTaskStarted', 'ActivityTaskCompleted', 'ActivityTaskFailed' ] | The type of event | [optional] +**timestamp** | **datetime** | The date-time when the event occurred | [optional] +**attributes** | **object** | Additional attributes associated with the event | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent + +workflow_execution_event = WorkflowExecutionEvent( +type=WorkflowTaskScheduled, +timestamp='2022-02-07T20:13:31.640618296Z', +attributes={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryAction.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..c2b6ac3c1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryAction.md @@ -0,0 +1,63 @@ +--- +id: beta-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryAction', 'BetaWorkflowLibraryAction'] +slug: /tools/sdk/python/beta/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'BetaWorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Action ID. This is a static namespaced ID for the action | [optional] +**name** | **str** | Action Name | [optional] +**type** | **str** | Action type | [optional] +**description** | **str** | Action Description | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**example_output** | [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**version_number** | **int** | Version number | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**output_schema** | **object** | Defines the output schema, if any, that this action produces. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction + +workflow_library_action = WorkflowLibraryAction( +id='sp:create-campaign', +name='Create Certification Campaign', +type='ACTION', +description='Generates a certification campaign.', +form_fields=[ + sailpoint.beta.models.workflow_library_form_fields.WorkflowLibraryFormFields( + description = 'First value to compare', + help_text = 'The name to give to this certification campaign.', + label = 'Campaign Name', + name = 'name', + required = False, + type = 'text', ) + ], +example_output=, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +version_number=56, +is_simulation_enabled=True, +is_dynamic_schema=False, +output_schema={definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..9cfa9157e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,31 @@ +--- +id: beta-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryActionExampleOutput', 'BetaWorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/python/beta/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'BetaWorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.beta.models.workflow_library_action_example_output import WorkflowLibraryActionExampleOutput + +workflow_library_action_example_output = WorkflowLibraryActionExampleOutput( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..7f8992b02 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,43 @@ +--- +id: beta-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryFormFields', 'BetaWorkflowLibraryFormFields'] +slug: /tools/sdk/python/beta/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'BetaWorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Description of the form field | [optional] +**help_text** | **str** | Describes the form field in the UI | [optional] +**label** | **str** | A human readable name for this form field in the UI | [optional] +**name** | **str** | The name of the input attribute | [optional] +**required** | **bool** | Denotes if this field is a required attribute | [optional] +**type** | **Enum** [ 'text', 'textarea', 'boolean', 'email', 'url', 'number', 'json', 'checkbox', 'jsonpath', 'select', 'multiType', 'duration', 'toggle', 'formPicker', 'identityPicker', 'governanceGroupPicker', 'string', 'object', 'array', 'secret', 'keyValuePairs', 'emailPicker', 'advancedToggle', 'variableCreator', 'htmlEditor' ] | The type of the form field | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_library_form_fields import WorkflowLibraryFormFields + +workflow_library_form_fields = WorkflowLibraryFormFields( +description='First value to compare', +help_text='The name to give to this certification campaign.', +label='Campaign Name', +name='name', +required=False, +type='text' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..c5745ed2e --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryOperator.md @@ -0,0 +1,49 @@ +--- +id: beta-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryOperator', 'BetaWorkflowLibraryOperator'] +slug: /tools/sdk/python/beta/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'BetaWorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Operator ID. | [optional] +**name** | **str** | Operator friendly name | [optional] +**type** | **str** | Operator type | [optional] +**description** | **str** | Description of the operator | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator + +workflow_library_operator = WorkflowLibraryOperator( +id='sp:compare-boolean', +name='Compare Boolean Values', +type='OPERATOR', +description='Compare two boolean values and decide what happens based on the result.', +is_dynamic_schema=False, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +is_simulation_enabled=True, +form_fields=[{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..f4105cdbc --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,53 @@ +--- +id: beta-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryTrigger', 'BetaWorkflowLibraryTrigger'] +slug: /tools/sdk/python/beta/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'BetaWorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**type** | **Enum** [ 'EVENT', 'SCHEDULED', 'EXTERNAL' ] | Trigger type | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**output_schema** | **object** | Example output schema | [optional] +**name** | **str** | Trigger Name | [optional] +**description** | **str** | Trigger Description | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**input_example** | **object** | Example trigger payload if applicable | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger + +workflow_library_trigger = WorkflowLibraryTrigger( +id='idn:identity-attributes-changed', +type='EVENT', +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +is_simulation_enabled=True, +output_schema=None, +name='Identity Attributes Changed', +description='One or more identity attributes changed.', +is_dynamic_schema=False, +input_example={changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}}, +form_fields=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowModifiedBy.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..fb36ad2f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowModifiedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowModifiedBy', 'BetaWorkflowModifiedBy'] +slug: /tools/sdk/python/beta/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'BetaWorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | | [optional] +**id** | **str** | Identity ID | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_modified_by import WorkflowModifiedBy + +workflow_modified_by = WorkflowModifiedBy( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowOAuthClient.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..1e3710801 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowOAuthClient.md @@ -0,0 +1,37 @@ +--- +id: beta-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowOAuthClient', 'BetaWorkflowOAuthClient'] +slug: /tools/sdk/python/beta/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'BetaWorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**secret** | **str** | OAuthClient secret. | [optional] +**url** | **str** | URL for the external trigger to invoke | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient + +workflow_o_auth_client = WorkflowOAuthClient( +id='1a58c03a6bf64dc2876f6988c6e2c7b7', +secret='00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowTrigger.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowTrigger.md new file mode 100644 index 000000000..a3646392c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowTrigger.md @@ -0,0 +1,38 @@ +--- +id: beta-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowTrigger', 'BetaWorkflowTrigger'] +slug: /tools/sdk/python/beta/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'BetaWorkflowTrigger'] +--- + +# WorkflowTrigger + +The trigger that starts the workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'EVENT', 'EXTERNAL', 'SCHEDULED', '' ] | The trigger type | [required] +**display_name** | **str** | | [optional] +**attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] +} + +## Example + +```python +from sailpoint.beta.models.workflow_trigger import WorkflowTrigger + +workflow_trigger = WorkflowTrigger( +type='EVENT', +display_name='', +attributes= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowTriggerAttributes.md new file mode 100644 index 000000000..78c195d7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowTriggerAttributes.md @@ -0,0 +1,54 @@ +--- +id: beta-workflow-trigger-attributes +title: WorkflowTriggerAttributes +pagination_label: WorkflowTriggerAttributes +sidebar_label: WorkflowTriggerAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowTriggerAttributes', 'BetaWorkflowTriggerAttributes'] +slug: /tools/sdk/python/beta/models/workflow-trigger-attributes +tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'BetaWorkflowTriggerAttributes'] +--- + +# WorkflowTriggerAttributes + +Workflow Trigger Attributes. + +## 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** | Additional context about the external trigger | [optional] +**name** | **str** | A unique name for the external trigger | [optional] +**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional] +**url** | **str** | URL to invoke this workflow | [optional] +**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required] +**time_zone** | **str** | Time zone identifier | [optional] +**cron_string** | **str** | | [optional] +**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional] +**weekly_times** | **[]str** | Scheduled execution times | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workflow_trigger_attributes import WorkflowTriggerAttributes + +workflow_trigger_attributes = WorkflowTriggerAttributes( +id='idn:identity-attributes-changed', +filter_='$.changes[?(@.attribute == 'manager')]', +description='Run a search and notify the results', +name='search-and-notify', +client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d', +frequency='daily', +time_zone='America/Chicago', +cron_string='0 9 * * 1', +weekly_days=Monday, +weekly_times=Monday +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..6158cbec0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: beta-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupBulkDeleteRequest', 'BetaWorkgroupBulkDeleteRequest'] +slug: /tools/sdk/python/beta/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'BetaWorkgroupBulkDeleteRequest'] +--- + +# WorkgroupBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of IDs of Governance Groups to be deleted. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest + +workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest( +ids=[567a697e-885b-495a-afc5-d55e1c23a302, c7b0f7b2-1e78-4063-b294-a555333dacd2] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..d9581f989 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupConnectionDto.md @@ -0,0 +1,39 @@ +--- +id: beta-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupConnectionDto', 'BetaWorkgroupConnectionDto'] +slug: /tools/sdk/python/beta/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'BetaWorkgroupConnectionDto'] +--- + +# WorkgroupConnectionDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | [**ConnectedObject**](connected-object) | | [optional] +**connection_type** | **Enum** [ 'AccessRequestReviewer', 'Owner', 'ManagementWorkgroup' ] | Connection Type. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_connection_dto import WorkgroupConnectionDto + +workgroup_connection_dto = WorkgroupConnectionDto( +object=sailpoint.beta.models.connected_object.ConnectedObject( + type = 'ACCESS_PROFILE', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database.', ), +connection_type='AccessRequestReviewer' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..b67fa60cf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDeleteItem.md @@ -0,0 +1,43 @@ +--- +id: beta-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupDeleteItem', 'BetaWorkgroupDeleteItem'] +slug: /tools/sdk/python/beta/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'BetaWorkgroupDeleteItem'] +--- + +# WorkgroupDeleteItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the Governance Group. | [required] +**status** | **int** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_delete_item import WorkgroupDeleteItem + +workgroup_delete_item = WorkgroupDeleteItem( +id='464ae7bf791e49fdb74606a2e4a89635', +status=204, +description=' +> Governance Group deleted successfully. + +> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. + +> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDto.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDto.md new file mode 100644 index 000000000..dca0d08bf --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDto.md @@ -0,0 +1,47 @@ +--- +id: beta-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupDto', 'BetaWorkgroupDto'] +slug: /tools/sdk/python/beta/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'BetaWorkgroupDto'] +--- + +# WorkgroupDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**owner** | [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**id** | **str** | Governance group ID. | [optional] [readonly] +**name** | **str** | Governance group name. | [optional] +**description** | **str** | Governance group description. | [optional] +**member_count** | **int** | Number of members in the governance group. | [optional] [readonly] +**connection_count** | **int** | Number of connections in the governance group. | [optional] [readonly] +**created** | **datetime** | | [optional] +**modified** | **datetime** | | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_dto import WorkgroupDto + +workgroup_dto = WorkgroupDto( +owner=, +id='2c91808568c529c60168cca6f90c1313', +name='DB Access Governance Group', +description='Description of the Governance Group', +member_count=1641498673000, +connection_count=1641498673000, +created='2022-01-06T19:51:13Z', +modified='2022-01-06T19:51:13Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..c6938d5be --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupDtoOwner.md @@ -0,0 +1,41 @@ +--- +id: beta-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupDtoOwner', 'BetaWorkgroupDtoOwner'] +slug: /tools/sdk/python/beta/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'BetaWorkgroupDtoOwner'] +--- + +# WorkgroupDtoOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. | [optional] +**display_name** | **str** | The display name of the identity | [optional] [readonly] +**email_address** | **str** | The primary email address of the identity | [optional] [readonly] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_dto_owner import WorkgroupDtoOwner + +workgroup_dto_owner = WorkgroupDtoOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support', +display_name='Support', +email_address='support@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..ec5e2fa64 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,41 @@ +--- +id: beta-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupMemberAddItem', 'BetaWorkgroupMemberAddItem'] +slug: /tools/sdk/python/beta/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'BetaWorkgroupMemberAddItem'] +--- + +# WorkgroupMemberAddItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of identity in bulk member add request. | [required] +**status** | **int** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_member_add_item import WorkgroupMemberAddItem + +workgroup_member_add_item = WorkgroupMemberAddItem( +id='464ae7bf791e49fdb74606a2e4a89635', +status=201, +description=' +> Identity is added into Governance Group members list. + +> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..26a0d8cd1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,41 @@ +--- +id: beta-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupMemberDeleteItem', 'BetaWorkgroupMemberDeleteItem'] +slug: /tools/sdk/python/beta/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'BetaWorkgroupMemberDeleteItem'] +--- + +# WorkgroupMemberDeleteItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of identity in bulk member add /remove request. | [required] +**status** | **int** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem + +workgroup_member_delete_item = WorkgroupMemberDeleteItem( +id='464ae7bf791e49fdb74606a2e4a89635', +status=204, +description=' +> Identity deleted from Governance Group members list. + +> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md new file mode 100644 index 000000000..3360a2a84 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md @@ -0,0 +1,293 @@ +--- +id: v2024-access-model-metadata +title: Access_Model_Metadata +pagination_label: Access_Model_Metadata +sidebar_label: Access_Model_Metadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Model_Metadata', 'V2024Access_Model_Metadata'] +slug: /tools/sdk/python/v2024/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'Access_Model_Metadata', 'V2024Access_Model_Metadata'] +--- + +# sailpoint.v2024.AccessModelMetadataApi + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + + +## get-access-model-metadata-attribute +:::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. +::: +Get Access Model Metadata Attribute +Get single Access Model Metadata Attribute + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | Technical name of the Attribute. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**AttributeDTO**](../models/attribute-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | AttributeDTO | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.attribute_dto import AttributeDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-model-metadata-attribute-value +:::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. +::: +Get Access Model Metadata Value +Get single Access Model Metadata Attribute Value + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | Technical name of the Attribute. +Path | value | **str** | True | Technical name of the Attribute value. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**AttributeValueDTO**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | AttributeValueDTO | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, value, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-model-metadata-attribute +:::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. +::: +List Access Model Metadata Attributes +Get a list of Access Model Metadata Attributes + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute) + +### 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 | 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**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* + +### Return type +[**List[AttributeDTO]**](../models/attribute-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | List[AttributeDTO] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.attribute_dto import AttributeDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-model-metadata-attribute-value +:::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. +::: +List Access Model Metadata Values +Get a list of Access Model Metadata Attribute Values + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | key | **str** | True | Technical name of the Attribute. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**List[AttributeValueDTO]**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | List[AttributeValueDTO] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md new file mode 100644 index 000000000..46ec3731a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -0,0 +1,715 @@ +--- +id: v2024-access-profiles +title: Access_Profiles +pagination_label: Access_Profiles +sidebar_label: Access_Profiles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Profiles', 'V2024Access_Profiles'] +slug: /tools/sdk/python/v2024/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'Access_Profiles', 'V2024Access_Profiles'] +--- + +# sailpoint.v2024.AccessProfilesApi + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +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. + +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. + +Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + + +## create-access-profile +Create Access Profile +Use this API to create an access profile. +A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile | [**AccessProfile**](../models/access-profile) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Access profile created. | AccessProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile import AccessProfile +from pprint import pprint +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() + new_access_profile.from_json(access_profile) + results =AccessProfilesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile 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 | Returned when an access profile cannot be deleted as it's being used. | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +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 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile_bulk_delete_request | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | + +### Return type +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse | - | +202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest +from sailpoint.v2024.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse +from pprint import pprint +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() + new_access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + results =AccessProfilesApi(api_client).delete_access_profiles_in_bulk(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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An AccessProfile | AccessProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile import AccessProfile +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the access profile containing the entitlements. + 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, 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. + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Use this API to get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles) + +### 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 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. + 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* **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. + 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 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. + Query | include_unsegmented | **bool** | (optional) (default to True) | 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. + +### Return type +[**List[AccessProfile]**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access profiles. | List[AccessProfile] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile import AccessProfile +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Access Profile as updated. | AccessProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile import AccessProfile +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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 + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =AccessProfilesApi(api_client).patch_access_profile(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-access-profiles-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. +::: +Update Access Profile(s) requestable field. +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. + A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-access-profiles-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 | access_profile_bulk_update_request_inner | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | True | + +### Return type +[**List[AccessProfileUpdateItem]**](../models/access-profile-update-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | List of updated and not updated Access Profiles. | List[AccessProfileUpdateItem] | - | +400 | Client Error - 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 | - | +412 | Precondition Failed - Returned in response if API/Feature not enabled for an organization. | UpdateAccessProfilesInBulk412Response | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner +from sailpoint.v2024.models.access_profile_update_item import AccessProfileUpdateItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + 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() + new_access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + results =AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md new file mode 100644 index 000000000..434014ad2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md @@ -0,0 +1,518 @@ +--- +id: v2024-access-request-approvals +title: Access_Request_Approvals +pagination_label: Access_Request_Approvals +sidebar_label: Access_Request_Approvals +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Request_Approvals', 'V2024Access_Request_Approvals'] +slug: /tools/sdk/python/v2024/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'Access_Request_Approvals', 'V2024Access_Request_Approvals'] +--- + +# sailpoint.v2024.AccessRequestApprovalsApi + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-access-request-approvers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers +[**list-completed-approvals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | comment_dto | [**CommentDto**](../models/comment-dto) | (optional) | Reviewer's comment. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.comment_dto import CommentDto +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | forward_approval_dto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.forward_approval_dto import ForwardApprovalDto +from pprint import pprint +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() + new_forward_approval_dto.from_json(forward_approval_dto) + results =AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-approval-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + Query | from_date | **str** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + +### Return type +[**ApprovalSummary**](../models/approval-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary | - | +400 | Client Error - Returned if the query parameter 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.approval_summary import ApprovalSummary +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-request-approvers +Access Request Approvers +This API endpoint returns the list of approvers for the given access request id. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-approvers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | access_request_id | **str** | True | Access Request ID. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. + Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + Query | count | **bool** | (optional) (default to False) | 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. + +### Return type +[**List[AccessRequestApproversListResponse]**](../models/access-request-approvers-list-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Approvers. | List[AccessRequestApproversListResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_approvers_list_response import AccessRequestApproversListResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID. + 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) + 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) + + try: + # Access Request Approvers + + results =AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, ) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) + print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-completed-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + 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, 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* + 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: **created, modified** + +### Return type +[**List[CompletedApproval]**](../models/completed-approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Completed Approvals. | List[CompletedApproval] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.completed_approval import CompletedApproval +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-pending-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *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: **created, modified** + +### Return type +[**List[PendingApproval]**](../models/pending-approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Pending Approvals. | List[PendingApproval] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.pending_approval import PendingApproval +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | comment_dto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.comment_dto import CommentDto +from pprint import pprint +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() + new_comment_dto.from_json(comment_dto) + results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md new file mode 100644 index 000000000..fa17ac143 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md @@ -0,0 +1,88 @@ +--- +id: v2024-access-request-identity-metrics +title: Access_Request_Identity_Metrics +pagination_label: Access_Request_Identity_Metrics +sidebar_label: Access_Request_Identity_Metrics +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Request_Identity_Metrics', 'V2024Access_Request_Identity_Metrics'] +slug: /tools/sdk/python/v2024/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'Access_Request_Identity_Metrics', 'V2024Access_Request_Identity_Metrics'] +--- + +# sailpoint.v2024.AccessRequestIdentityMetricsApi + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-request-identity-metrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + + +## get-access-request-identity-metrics +Return access request identity metrics +Use this API to return information access metrics. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Manager's identity ID. +Path | requested_object_id | **str** | True | Requested access item's ID. +Path | type | **str** | True | Requested access item's type. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of the resource access and source activity for the direct reports of the provided manager. | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, requested_object_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md new file mode 100644 index 000000000..986e13575 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -0,0 +1,761 @@ +--- +id: v2024-access-requests +title: Access_Requests +pagination_label: Access_Requests +sidebar_label: Access_Requests +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Requests', 'V2024Access_Requests'] +slug: /tools/sdk/python/v2024/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'Access_Requests', 'V2024Access_Requests'] +--- + +# sailpoint.v2024.AccessRequestsApi + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-bulk-access-request**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request +[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request +[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk Cancel Access Request +[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request +[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status +[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + + +## approve-bulk-access-request +Bulk Approve Access Request +This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-bulk-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_approve_access_request | [**BulkApproveAccessRequest**](../models/bulk-approve-access-request) | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.bulk_approve_access_request import BulkApproveAccessRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + bulk_approve_access_request = { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } # BulkApproveAccessRequest | + + try: + # Bulk Approve Access Request + new_bulk_approve_access_request = BulkApproveAccessRequest() + new_bulk_approve_access_request.from_json(bulk_approve_access_request) + results =AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request) + print("The response of AccessRequestsApi->approve_bulk_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | cancel_access_request | [**CancelAccessRequest**](../models/cancel-access-request) | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.cancel_access_request import CancelAccessRequest +from pprint import pprint +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() + new_cancel_access_request.from_json(cancel_access_request) + results =AccessRequestsApi(api_client).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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## cancel-access-request-in-bulk +Bulk Cancel Access Request +This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. +Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_cancel_access_request | [**BulkCancelAccessRequest**](../models/bulk-cancel-access-request) | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.bulk_cancel_access_request import BulkCancelAccessRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + bulk_cancel_access_request = { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } # BulkCancelAccessRequest | + + try: + # Bulk Cancel Access Request + new_bulk_cancel_access_request = BulkCancelAccessRequest() + new_bulk_cancel_access_request.from_json(bulk_cancel_access_request) + results =AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request) + print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## close-access-request +:::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. +::: +Close Access Request +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/close-access-request) + +### 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 | close_access_request | [**CloseAccessRequest**](../models/close-access-request) | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.close_access_request import CloseAccessRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_close_access_request.from_json(close_access_request) + results =AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. +These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request | [**AccessRequest**](../models/access-request) | True | + +### Return type +[**AccessRequestResponse**](../models/access-request-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Access Request Response. | AccessRequestResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request import AccessRequest +from sailpoint.v2024.models.access_request_response import AccessRequestResponse +from pprint import pprint +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() + new_access_request.from_json(access_request) + results =AccessRequestsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Access Request Configuration Details. | AccessRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_config import AccessRequestConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + Query | assigned_to | **str** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | count | **bool** | (optional) (default to False) | 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. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. + Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, 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: **created, modified, accountActivityItemId, name** + Query | request_state | **str** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**List[RequestedItemStatus]**](../models/requested-item-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of requested item statuses. | List[RequestedItemStatus] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.requested_item_status import RequestedItemStatus +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-administrators-access-request-status +Access Request Status for Administrators +Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. +Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-administrators-access-request-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + Query | assigned_to | **str** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | count | **bool** | (optional) (default to False) | 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. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. + Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, 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: **created, modified, accountActivityItemId, name, accessRequestId** + Query | request_state | **str** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**List[AccessRequestAdminItemStatus]**](../models/access-request-admin-item-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of requested item statuses. | List[AccessRequestAdminItemStatus] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus +from pprint import pprint +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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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, accessRequestId** (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, accessRequestId** (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 for Administrators + + results =AccessRequestsApi(api_client).list_administrators_access_request_status() + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) + print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_config | [**AccessRequestConfig**](../models/access-request-config) | True | + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Access Request Configuration Details. | AccessRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_config import AccessRequestConfig +from pprint import pprint +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() + new_access_request_config.from_json(access_request_config) + results =AccessRequestsApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md new file mode 100644 index 000000000..12cbca94a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md @@ -0,0 +1,189 @@ +--- +id: v2024-account-activities +title: Account_Activities +pagination_label: Account_Activities +sidebar_label: Account_Activities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Activities', 'V2024Account_Activities'] +slug: /tools/sdk/python/v2024/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'Account_Activities', 'V2024Account_Activities'] +--- + +# sailpoint.v2024.AccountActivitiesApi + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity +[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + + +## get-account-activity +Get an Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-activity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account activity id + +### Return type +[**AccountActivity**](../models/account-activity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An account activity object | AccountActivity | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.account_activities_api import AccountActivitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_activity import AccountActivity +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-account-activities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + 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: **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* + 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: **type, created, modified** + +### Return type +[**List[AccountActivity]**](../models/account-activity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of account activities | List[AccountActivity] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.account_activities_api import AccountActivitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_activity import AccountActivity +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md new file mode 100644 index 000000000..b4da7c5d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md @@ -0,0 +1,103 @@ +--- +id: v2024-account-aggregations +title: Account_Aggregations +pagination_label: Account_Aggregations +sidebar_label: Account_Aggregations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Aggregations', 'V2024Account_Aggregations'] +slug: /tools/sdk/python/v2024/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'Account_Aggregations', 'V2024Account_Aggregations'] +--- + +# sailpoint.v2024.AccountAggregationsApi + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-aggregation-status**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + + +## get-account-aggregation-status +:::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. +::: +In-progress Account Aggregation status +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* +required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-aggregation-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account aggregation id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An account aggregation status object | AccountAggregationStatus | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.account_aggregations_api import AccountAggregationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_aggregation_status import AccountAggregationStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md new file mode 100644 index 000000000..00dc22099 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md @@ -0,0 +1,92 @@ +--- +id: v2024-account-usages +title: Account_Usages +pagination_label: Account_Usages +sidebar_label: Account_Usages +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Usages', 'V2024Account_Usages'] +slug: /tools/sdk/python/v2024/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'Account_Usages', 'V2024Account_Usages'] +--- + +# sailpoint.v2024.AccountUsagesApi + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-usages-by-account-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | account_id | **str** | True | ID of IDN account + 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 | 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: **date** + +### Return type +[**List[AccountUsage]**](../models/account-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of account usage insights for past 12 months. | List[AccountUsage] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.account_usages_api import AccountUsagesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_usage import AccountUsage +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md new file mode 100644 index 000000000..10fac92ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md @@ -0,0 +1,1151 @@ +--- +id: v2024-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Accounts', 'V2024Accounts'] +slug: /tools/sdk/python/v2024/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'V2024Accounts'] +--- + +# sailpoint.v2024.AccountsApi + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **POST** `/accounts` | Create Account +[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account +[**delete-account-async**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account +[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account +[**disable-account-for-identity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account +[**enable-account-for-identity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts List +[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + + +## create-account +Create Account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | account_attributes_create | [**AccountAttributesCreate**](../models/account-attributes-create) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_attributes_create import AccountAttributesCreate +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_attributes_create.from_json(account_attributes_create) + results =AccountsApi(api_client).create_account(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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-account +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-account-async +:::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. +::: +Remove Account +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. Returns task result details of removal request. | 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_result_dto import TaskResultDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-account +Disable Account +This API submits a task to disable the account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + Body | account_toggle_request | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_toggle_request.from_json(account_toggle_request) + results =AccountsApi(api_client).disable_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-account-for-identity +:::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. +::: +Disable IDN Account for Identity +This API submits a task to disable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-accounts-for-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. +::: +Disable IDN Accounts for Identities +This API submits tasks to disable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities) + +### 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 | identities_accounts_bulk_request | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**List[BulkIdentitiesAccountsResponse]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | Bulk response details. | List[BulkIdentitiesAccountsResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse +from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + results =AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-account +Enable Account +This API submits a task to enable account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + Body | account_toggle_request | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_toggle_request.from_json(account_toggle_request) + results =AccountsApi(api_client).enable_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-account-for-identity +:::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. +::: +Enable IDN Account for Identity +This API submits a task to enable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-accounts-for-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. +::: +Enable IDN Accounts for Identities +This API submits tasks to enable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities) + +### 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 | identities_accounts_bulk_request | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**List[BulkIdentitiesAccountsResponse]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | Bulk response details. | List[BulkIdentitiesAccountsResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse +from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + results =AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-account +Account Details +Use this API to return the details for a single account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + +### Return type +[**Account**](../models/account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Account object. | Account | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account import Account +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-account-entitlements +Account Entitlements +This API returns entitlements of the account. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + 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[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An array of account 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-accounts +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts) + +### 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 | detail_level | **str** | (optional) | 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. + 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, 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* + 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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + +### Return type +[**List[Account]**](../models/account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of account objects. | List[Account] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account import Account +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-account +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + Body | account_attributes | [**AccountAttributes**](../models/account-attributes) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_attributes import AccountAttributes +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_attributes.from_json(account_attributes) + results =AccountsApi(api_client).put_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-reload-account +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reload-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## unlock-account +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/unlock-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account ID. + Body | account_unlock_request | [**AccountUnlockRequest**](../models/account-unlock-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.account_unlock_request import AccountUnlockRequest +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult +from pprint import pprint +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() + new_account_unlock_request.from_json(account_unlock_request) + results =AccountsApi(api_client).unlock_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-account +Update Account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + Body | request_body | **[]object** | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.accounts_api import AccountsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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. + 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() + new_request_body.from_json(request_body) + results =AccountsApi(api_client).update_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md new file mode 100644 index 000000000..8e4fe8f2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md @@ -0,0 +1,209 @@ +--- +id: v2024-application-discovery +title: Application_Discovery +pagination_label: Application_Discovery +sidebar_label: Application_Discovery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Application_Discovery', 'V2024Application_Discovery'] +slug: /tools/sdk/python/v2024/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'Application_Discovery', 'V2024Application_Discovery'] +--- + +# sailpoint.v2024.ApplicationDiscoveryApi + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-applications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-applications +Get Discovered Applications for Tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-discovered-applications) + +### 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 | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + Query | filter | **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**: *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* + 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, description, discoveredAt, discoverySource** + +### Return type +[**List[GetDiscoveredApplications200ResponseInner]**](../models/get-discovered-applications200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | List[GetDiscoveredApplications200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-manual-discover-applications-csv-template) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate | - | +400 | Client Error - 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**: text/csv, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-manual-discover-applications-csv-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | file | **bytearray** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The CSV has been successfully processed. | | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md new file mode 100644 index 000000000..6e62dc8ea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md @@ -0,0 +1,159 @@ +--- +id: v2024-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Approvals', 'V2024Approvals'] +slug: /tools/sdk/python/v2024/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'V2024Approvals'] +--- + +# sailpoint.v2024.ApprovalsApi + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval +[**get-approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals + + +## get-approval +:::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. +::: +Get an approval +Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the approval that is to be returned + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**Approval**](../models/approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Approval object | Approval | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.approvals_api import ApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.approval import Approval +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-approvals +:::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. +::: +Get Approvals +Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approvals) + +### 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 | mine | **bool** | (optional) | Returns the list of approvals for the current caller + Query | requester_id | **str** | (optional) | Returns the list of approvals for a given requester ID + 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: **status**: *eq* **referenceType**: *eq* + +### Return type +[**List[Approval]**](../models/approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Approvals | List[Approval] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.approvals_api import ApprovalsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.approval import Approval +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md new file mode 100644 index 000000000..d9731e1d9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md @@ -0,0 +1,1034 @@ +--- +id: v2024-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Apps', 'V2024Apps'] +slug: /tools/sdk/python/v2024/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'V2024Apps'] +--- + +# sailpoint.v2024.AppsApi + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-app**](#create-source-app) | **POST** `/source-apps` | Create source app +[**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**delete-source-app**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID +[**get-source-app**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID +[**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**list-all-source-app**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps +[**list-all-user-apps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps +[**list-assigned-source-app**](#list-assigned-source-app) | **GET** `/source-apps/assigned` | List assigned source apps +[**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**list-available-source-apps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps +[**list-owned-user-apps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps +[**patch-source-app**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID +[**patch-user-app**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID +[**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps + + +## create-source-app +:::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. +::: +Create source app +This endpoint creates a source app using the given source app payload + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-app) + +### 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 | source_app_create_dto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True | + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app as created. | SourceApp | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app import SourceApp +from sailpoint.v2024.models.source_app_create_dto import SourceAppCreateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_source_app_create_dto.from_json(source_app_create_dto) + results =AppsApi(api_client).create_source_app(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-profiles-from-source-app-by-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. +::: +Bulk remove access profiles from the specified source app +This API returns the final list of access profiles for the specified source app after removing + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-from-source-app-by-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | request_body | **[]str** | True | + 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. + +### Return type +[**List[AccessProfileDetails]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The final list of access profiles for the specified source app | List[AccessProfileDetails] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile_details import AccessProfileDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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] | + 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() + new_request_body.from_json(request_body) + results =AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-source-app +:::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. +::: +Delete source app by ID +Use this API to delete a specific source app + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | source app ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app as deleted. | SourceApp | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-app +:::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. +::: +Get source app by ID +This API returns a source app by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app. | SourceApp | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-profiles-for-source-app +:::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. +::: +List access profiles for the specified source app +This API returns the list of access profiles for the specified source app + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles-for-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app + | 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: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**List[AccessProfileDetails]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access profiles for the specified source app | List[AccessProfileDetails] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile_details import AccessProfileDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-all-source-app +:::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. +::: +List all source apps +This API returns the list of all source apps for the org. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-source-app) + +### 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 | 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 | 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 | 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, owner.id, accountSource.id** + 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* + +### Return type +[**List[SourceApp]**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of source apps | List[SourceApp] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-all-user-apps +:::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. +::: +List all user apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-user-apps) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | filters | **str** | True | Filter results using the standard syntax described in [V3 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 | **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 | 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 | 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[UserApp]**](../models/user-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of user apps | List[UserApp] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.user_app import UserApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-assigned-source-app +:::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. +::: +List assigned source apps +This API returns the list of source apps assigned for logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-assigned-source-app) + +### 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 | 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 | 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 | 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, accountSource.id** + 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**List[SourceApp]**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of source apps | List[SourceApp] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-available-accounts-for-user-app +:::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. +::: +List available accounts for user app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-accounts-for-user-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the user app + | 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 | 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[AppAccountDetails]**](../models/app-account-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of available accounts for the specified user app | List[AppAccountDetails] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.app_account_details import AppAccountDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-available-source-apps +:::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. +::: +List available source apps +This API returns the list of source apps available for access request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-source-apps) + +### 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 | 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 | 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 | 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, owner.id, accountSource.id** + 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, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**List[SourceApp]**](../models/source-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of source apps | List[SourceApp] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app import SourceApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-owned-user-apps +:::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. +::: +List owned user apps +This API returns the list of user apps assigned to logged in user + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-owned-user-apps) + +### 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 | 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 | 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: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + +### Return type +[**List[UserApp]**](../models/user-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of user apps | List[UserApp] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.user_app import UserApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-source-app +:::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. +::: +Patch source app by ID +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-source-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the source app 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) | (optional) | + +### Return type +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the source app as updated. | SourceAppPatchDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.source_app_patch_dto import SourceAppPatchDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch source app by ID + + results =AppsApi(api_client).patch_source_app(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-user-app +:::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. +::: +Patch user app by ID +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-user-app) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the user app 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) | (optional) | + +### Return type +[**UserApp**](../models/user-app) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the user app as updated. | UserApp | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.user_app import UserApp +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch user app by ID + + results =AppsApi(api_client).patch_user_app(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-apps-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. +::: +Bulk update source apps +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-apps-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 | source_app_bulk_update_request | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) | + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.apps_api import AppsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md new file mode 100644 index 000000000..37c1b513c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md @@ -0,0 +1,232 @@ +--- +id: v2024-auth-profile +title: Auth_Profile +pagination_label: Auth_Profile +sidebar_label: Auth_Profile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Auth_Profile', 'V2024Auth_Profile'] +slug: /tools/sdk/python/v2024/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'Auth_Profile', 'V2024Auth_Profile'] +--- + +# sailpoint.v2024.AuthProfileApi + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-profile-config**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile +[**get-profile-config-list**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles +[**patch-profile-config**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile + + +## get-profile-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. +::: +Get Auth Profile +This API returns auth profile information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-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. +Path | id | **str** | True | ID of the Auth Profile to patch. + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Profile | AuthProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.auth_profile_api import AuthProfileApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.auth_profile import AuthProfile +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-profile-config-list +:::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. +::: +Get list of Auth Profiles +This API returns a list of auth profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list) + +### 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[AuthProfileSummary]**](../models/auth-profile-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Auth Profiles | List[AuthProfileSummary] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.auth_profile_api import AuthProfileApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.auth_profile_summary import AuthProfileSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-profile-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. +::: +Patch a specified Auth Profile +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-profile-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Auth Profile 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 +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Auth Profile as updated. | AuthProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.auth_profile_api import AuthProfileApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.auth_profile import AuthProfile +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Auth Profile + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md new file mode 100644 index 000000000..1618e775e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md @@ -0,0 +1,162 @@ +--- +id: v2024-auth-users +title: Auth_Users +pagination_label: Auth_Users +sidebar_label: Auth_Users +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Auth_Users', 'V2024Auth_Users'] +slug: /tools/sdk/python/v2024/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'Auth_Users', 'V2024Auth_Users'] +--- + +# sailpoint.v2024.AuthUsersApi + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-auth-user**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details +[**patch-auth-user**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update + + +## get-auth-user +Auth User Details +Return the specified user's authentication system details. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-user) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity ID + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The specified user's authentication system details. | AuthUser | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.auth_users_api import AuthUsersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.auth_user import AuthUser +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-user +Auth User Update +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-user) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity ID + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth user updated. | AuthUser | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.auth_users_api import AuthUsersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.auth_user import AuthUser +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =AuthUsersApi(api_client).patch_auth_user(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md new file mode 100644 index 000000000..0d5a7a6ab --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md @@ -0,0 +1,352 @@ +--- +id: v2024-branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Branding', 'V2024Branding'] +slug: /tools/sdk/python/v2024/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'V2024Branding'] +--- + +# sailpoint.v2024.BrandingApi + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-branding-item**](#create-branding-item) | **POST** `/brandings` | Create a branding item +[**delete-branding**](#delete-branding) | **DELETE** `/brandings/{name}` | Delete a branding item +[**get-branding**](#get-branding) | **GET** `/brandings/{name}` | Get a branding item +[**get-branding-list**](#get-branding-list) | **GET** `/brandings` | List of branding items +[**set-branding-item**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item + + +## create-branding-item +Create a branding item +This API endpoint creates a branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-branding-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | name | **str** | True | name of branding item + | product_name | **str** | True | product name + | action_button_color | **str** | (optional) | hex value of color for action button + | active_link_color | **str** | (optional) | hex value of color for link + | navigation_color | **str** | (optional) | hex value of color for navigation bar + | email_from_address | **str** | (optional) | email from address + | login_informational_message | **str** | (optional) | login information message + | file_standard | **bytearray** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Branding item created | BrandingItem | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.branding_api import BrandingApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.branding_item import BrandingItem +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-branding +Delete a branding item +This API endpoint delete information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-branding) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The name of the branding item to be deleted + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.branding_api import BrandingApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-branding +Get a branding item +This API endpoint retrieves information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-branding) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The name of the branding item to be retrieved + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A branding item object | BrandingItem | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.branding_api import BrandingApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.branding_item import BrandingItem +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-branding-list +List of branding items +This API endpoint returns a list of branding items. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-branding-list) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[BrandingItem]**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of branding items. | List[BrandingItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.branding_api import BrandingApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.branding_item import BrandingItem +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-branding-item +Update a branding item +This API endpoint updates information for an existing branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-branding-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The name of the branding item to be retrieved + | name2 | **str** | True | name of branding item + | product_name | **str** | True | product name + | action_button_color | **str** | (optional) | hex value of color for action button + | active_link_color | **str** | (optional) | hex value of color for link + | navigation_color | **str** | (optional) | hex value of color for navigation bar + | email_from_address | **str** | (optional) | email from address + | login_informational_message | **str** | (optional) | login information message + | file_standard | **bytearray** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Branding item updated | BrandingItem | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.branding_api import BrandingApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.branding_item import BrandingItem +from pprint import pprint +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, name2, 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") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md new file mode 100644 index 000000000..01a3da0af --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md @@ -0,0 +1,392 @@ +--- +id: v2024-certification-campaign-filters +title: Certification_Campaign_Filters +pagination_label: Certification_Campaign_Filters +sidebar_label: Certification_Campaign_Filters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Campaign_Filters', 'V2024Certification_Campaign_Filters'] +slug: /tools/sdk/python/v2024/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'Certification_Campaign_Filters', 'V2024Certification_Campaign_Filters'] +--- + +# sailpoint.v2024.CertificationCampaignFiltersApi + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-campaign-filter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter +[**delete-campaign-filters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**list-campaign-filters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters +[**update-campaign-filter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter + + +## create-campaign-filter +Create Campaign Filter +Use this API to create a campaign filter based on filter details and criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_filter_details | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignFilterDetails | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails +from pprint import pprint +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() + new_campaign_filter_details.from_json(campaign_filter_details) + results =CertificationCampaignFiltersApi(api_client).create_campaign_filter(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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-campaign-filters +Deletes Campaign Filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-filters) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | True | A json list of IDs of campaign filters 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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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. + 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() + new_request_body.from_json(request_body) + CertificationCampaignFiltersApi(api_client).delete_campaign_filters(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) +``` + + + +[[Back to top]](#) + +## get-campaign-filter-by-id +Get Campaign Filter by ID +Retrieves information for an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-filter-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the campaign filter to be retrieved. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A campaign filter object. | CampaignFilterDetails | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-campaign-filters +List Campaign Filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-campaign-filters) + +### 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 | start | **int** | (optional) (default to 0) | 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. + Query | include_system_filters | **bool** | (optional) (default to True) | 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. + +### Return type +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of campaign filter objects. | ListCampaignFilters200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_campaign_filters200_response import ListCampaignFilters200Response +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-campaign-filter +Updates a Campaign Filter +Updates an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | filter_id | **str** | True | The ID of the campaign filter being modified. + Body | campaign_filter_details | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | A campaign filter details with updated field values. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignFilterDetails | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails +from pprint import pprint +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() + new_campaign_filter_details.from_json(campaign_filter_details) + results =CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md new file mode 100644 index 000000000..d1a478537 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md @@ -0,0 +1,1774 @@ +--- +id: v2024-certification-campaigns +title: Certification_Campaigns +pagination_label: Certification_Campaigns +sidebar_label: Certification_Campaigns +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Campaigns', 'V2024Certification_Campaigns'] +slug: /tools/sdk/python/v2024/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'Certification_Campaigns', 'V2024Certification_Campaigns'] +--- + +# sailpoint.v2024.CertificationCampaignsApi + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign +[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Campaign ID. + Body | campaign_complete_options | [**CampaignCompleteOptions**](../models/campaign-complete-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_complete_options import CampaignCompleteOptions +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-campaign +Create a campaign +Use this API to create a certification campaign with the information provided in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign | [**Campaign**](../models/campaign) | True | + +### Return type +[**Campaign**](../models/campaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign import Campaign +from pprint import pprint +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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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() + new_campaign.from_json(campaign) + results =CertificationCampaignsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-campaign-template +Create a Campaign Template +Use this API to create a certification campaign template based on campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_template | [**CampaignTemplate**](../models/campaign-template) | True | + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignTemplate | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_template import CampaignTemplate +from pprint import pprint +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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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() + new_campaign_template.from_json(campaign_template) + results =CertificationCampaignsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-campaign-template +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being deleted. + +### 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 | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-campaign-template-schedule +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template whose schedule is being deleted. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-campaigns +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaigns) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaigns_delete_request | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | True | IDs of the campaigns to delete. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaigns_delete_request import CampaignsDeleteRequest +from pprint import pprint +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() + new_campaigns_delete_request.from_json(campaigns_delete_request) + results =CertificationCampaignsApi(api_client).delete_campaigns(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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-active-campaigns +List Campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-active-campaigns) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + 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, sw* **status**: *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, created** + +### Return type +[**List[GetActiveCampaigns200ResponseInner]**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of campaign objects. By default list of SLIM campaigns is returned. | List[GetActiveCampaigns200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign to be retrieved. + Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + +### Return type +[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-reports +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-reports) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign whose reports are being fetched. + +### Return type +[**List[CampaignReport]**](../models/campaign-report) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Array of campaign report objects. | List[CampaignReport] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_report import CampaignReport +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-reports-config +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-reports-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Campaign report configuration. | CampaignReportsConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-template +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Requested campaign template's ID. + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Data for the campaign matching the given ID. | CampaignTemplate | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_template import CampaignTemplate +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-template-schedule +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template whose schedule is being fetched. + +### Return type +[**Schedule**](../models/schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) for more examples. | Schedule | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.schedule import Schedule +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-templates +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-templates) + +### 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 | 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 | 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**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + +### Return type +[**List[CampaignTemplate]**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of campaign template objects. | List[CampaignTemplate] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_template import CampaignTemplate +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +``` + + + +[[Back to top]](#) + +## move +Reassign Certifications +This API reassigns the specified certifications from one identity to another. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/move) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification campaign ID + Body | admin_review_reassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The reassign task that has been submitted. | CertificationTask | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.admin_review_reassign import AdminReviewReassign +from sailpoint.v2024.models.certification_task import CertificationTask +from pprint import pprint +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() + new_admin_review_reassign.from_json(admin_review_reassign) + results =CertificationCampaignsApi(api_client).move(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-campaign-template +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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) + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_template import CampaignTemplate +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =CertificationCampaignsApi(api_client).patch_campaign_template(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-campaign-reports-config +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-campaign-reports-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_reports_config | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted campaign report configuration. | CampaignReportsConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig +from pprint import pprint +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() + new_campaign_reports_config.from_json(campaign_reports_config) + results =CertificationCampaignsApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-campaign-template-schedule +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being scheduled. + Body | schedule | [**Schedule**](../models/schedule) | (optional) | + +### 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 | - | +400 | Client Error - Returned if the request body is invalid. | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.schedule import Schedule +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## start-campaign +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Campaign ID. + Body | activate_campaign_options | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | 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. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.activate_campaign_options import ActivateCampaignOptions +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-campaign-remediation-scan +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign-remediation-scan) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign the remediation scan is being run for. + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-campaign-report +Run Campaign Report +Use this API to run a report for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign the report is being run for. +Path | type | [**ReportType**](../models/report-type) | True | Type of the report to run. + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_type import ReportType +from pprint import pprint +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.v2024.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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-generate-campaign-template +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-generate-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template to use for generation. + +### Return type +[**CampaignReference**](../models/campaign-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.campaign_reference import CampaignReference +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-campaign +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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 + +### Return type +[**SlimCampaign**](../models/slim-campaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | SlimCampaign | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.slim_campaign import SlimCampaign +from pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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() + new_json_patch_operation.from_json(json_patch_operation) + results =CertificationCampaignsApi(api_client).update_campaign(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md new file mode 100644 index 000000000..31ebeabcf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md @@ -0,0 +1,305 @@ +--- +id: v2024-certification-summaries +title: Certification_Summaries +pagination_label: Certification_Summaries +sidebar_label: Certification_Summaries +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Summaries', 'V2024Certification_Summaries'] +slug: /tools/sdk/python/v2024/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'Certification_Summaries', 'V2024Certification_Summaries'] +--- + +# sailpoint.v2024.CertificationSummariesApi + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-access-summaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**get-identity-summaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**get-identity-summary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + + +## get-identity-access-summaries +Access Summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-access-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID +Path | type | **str** | True | The type of access review item to retrieve summaries for + 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, 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: **access.name** + +### Return type +[**List[AccessSummary]**](../models/access-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access summaries | List[AccessSummary] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_summary import AccessSummary +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-decision-summary +Summary of Certification Decisions +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-decision-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification ID + 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: **identitySummary.id**: *eq, in* + +### Return type +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of the decisions made | IdentityCertDecisionSummary | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-summaries +Identity Summaries for Campaign Certification +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + 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* **completed**: *eq, ne* **name**: *eq, 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[CertificationIdentitySummary]**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity summaries | List[CertificationIdentitySummary] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-summary +Summary for Identity +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID +Path | identity_summary_id | **str** | True | The identity summary ID + +### Return type +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity summary | CertificationIdentitySummary | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md new file mode 100644 index 000000000..def595162 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md @@ -0,0 +1,818 @@ +--- +id: v2024-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certifications', 'V2024Certifications'] +slug: /tools/sdk/python/v2024/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'V2024Certifications'] +--- + +# sailpoint.v2024.CertificationsApi + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-certification-task**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID +[**get-identity-certification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items +[**list-identity-certifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications +[**make-identity-decision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-certification-task +Certification Task by ID +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-certification-task) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The task ID + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A certification task | CertificationTask | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.certification_task import CertificationTask +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-certification +Identity Certification by ID +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification id + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification object | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-certification-item-permissions +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification-item-permissions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | certification_id | **str** | True | The certification ID +Path | item_id | **str** | True | The certification item ID + 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: **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 + 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[PermissionDto]**](../models/permission-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of permissions associated with the given itemId | List[PermissionDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.permission_dto import PermissionDto +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-pending-certification-tasks +List of Pending Certification Tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-certification-tasks) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | reviewer_identity | **str** | (optional) | The ID of reviewer identity. *me* indicates the current user. + 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* **targetId**: *eq, in* **type**: *eq, in* + +### Return type +[**List[CertificationTask]**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of pending certification tasks | List[CertificationTask] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.certification_task import CertificationTask +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-certification-reviewers +List of Reviewers for certification +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-certification-reviewers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification ID + 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, sw* **email**: *eq, 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, email** + +### Return type +[**List[IdentityReferenceWithNameAndEmail]**](../models/identity-reference-with-name-and-email) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of reviewers | List[IdentityReferenceWithNameAndEmail] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-access-review-items +List of Access Review Items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-review-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + 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* **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* + 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + Query | entitlements | **str** | (optional) | 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. + Query | access_profiles | **str** | (optional) | 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. + Query | roles | **str** | (optional) | 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. + +### Return type +[**List[AccessReviewItem]**](../models/access-review-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of access review items | List[AccessReviewItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_review_item import AccessReviewItem +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-certifications +List Identity Campaign Certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-certifications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | reviewer_identity | **str** | (optional) | Reviewer's identity. *me* indicates the current user. + 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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, due, signed** + +### Return type +[**List[IdentityCertificationDto]**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity campaign certifications. | List[IdentityCertificationDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## make-identity-decision +Decide on a Certification Item +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/make-identity-decision) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the identity campaign certification on which to make decisions + Body | review_decision | [**[]ReviewDecision**](../models/review-decision) | True | A non-empty array of decisions to be made. + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification object | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto +from sailpoint.v2024.models.review_decision import ReviewDecision +from pprint import pprint +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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + + try: + # Decide on a Certification Item + new_review_decision = ReviewDecision() + new_review_decision.from_json(review_decision) + results =CertificationsApi(api_client).make_identity_decision(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reassign-identity-certifications +Reassign Identities or Items +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reassign-identity-certifications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + Body | review_reassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification details after completing the reassignment. | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto +from sailpoint.v2024.models.review_reassign import ReviewReassign +from pprint import pprint +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() + new_review_reassign.from_json(review_reassign) + results =CertificationsApi(api_client).reassign_identity_certifications(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sign-off-identity-certification +Finalize Identity Certification Decisions +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sign-off-identity-certification) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification object | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-reassign-certs-async +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reassign-certs-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + Body | review_reassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A certification task object for the reassignment which can be queried for status. | CertificationTask | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.certifications_api import CertificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.certification_task import CertificationTask +from sailpoint.v2024.models.review_reassign import ReviewReassign +from pprint import pprint +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() + new_review_reassign.from_json(review_reassign) + results =CertificationsApi(api_client).submit_reassign_certs_async(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md new file mode 100644 index 000000000..c05a48d0e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md @@ -0,0 +1,1071 @@ +--- +id: v2024-configuration-hub +title: Configuration_Hub +pagination_label: Configuration_Hub +sidebar_label: Configuration_Hub +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Configuration_Hub', 'V2024Configuration_Hub'] +slug: /tools/sdk/python/v2024/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'Configuration_Hub', 'V2024Configuration_Hub'] +--- + +# sailpoint.v2024.ConfigurationHubApi + Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment. + +Common usages for Configuration Hub includes: + +- Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. +- Manage object mapping - Create rules to map and substitute attributes when migrating configurations. +- Manage backups for configuration settings +- Manage configuration drafts +- Upload configurations and manage object mappings between tenants. + +Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy +[**create-object-mapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**create-object-mappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**create-uploaded-configuration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration +[**delete-backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup +[**delete-draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft +[**delete-object-mapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**get-deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy +[**get-object-mappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**get-uploaded-configuration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**list-backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups +[**list-deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys +[**list-drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts +[**list-uploaded-configurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**update-object-mappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + + +## create-deploy +Create a Deploy +This API performs a deploy based on an existing daft. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-deploy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | deploy_request | [**DeployRequest**](../models/deploy-request) | True | The deploy request body. + +### Return type +[**DeployResponse**](../models/deploy-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Deploy job accepted and queued for processing. | DeployResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.deploy_request import DeployRequest +from sailpoint.v2024.models.deploy_response import DeployResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + deploy_request = { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } # DeployRequest | The deploy request body. + + try: + # Create a Deploy + new_deploy_request = DeployRequest() + new_deploy_request.from_json(deploy_request) + results =ConfigurationHubApi(api_client).create_deploy(new_deploy_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request) + print("The response of ConfigurationHubApi->create_deploy:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-object-mapping +Creates an object mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + Body | object_mapping_request | [**ObjectMappingRequest**](../models/object-mapping-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingResponse**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The created object mapping between current org and source org. | ObjectMappingResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.object_mapping_request import ObjectMappingRequest +from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse +from pprint import pprint +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() + new_object_mapping_request.from_json(object_mapping_request) + results =ConfigurationHubApi(api_client).create_object_mapping(source_org, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-object-mappings +Bulk creates object mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mappings) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + Body | object_mapping_bulk_create_request | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | True | The bulk create object mapping request body. + +### Return type +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The created object mapping between current org and source org. | ObjectMappingBulkCreateResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest +from sailpoint.v2024.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse +from pprint import pprint +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() + new_object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + results =ConfigurationHubApi(api_client).create_object_mappings(source_org, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-uploaded-configuration +Upload a Configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-uploaded-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | data | **bytearray** | True | JSON file containing the objects to be imported. + | name | **str** | True | Name that will be assigned to the uploaded configuration file. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Upload job accepted and queued for processing. | BackupResponse | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.backup_response import BackupResponse +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-backup +Delete a Backup +This API deletes an existing backup for the current tenant. + +On success, this endpoint will return an empty response. + +The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-backup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the backup 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete. + + try: + # Delete a Backup + + ConfigurationHubApi(api_client).delete_backup(id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_backup(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-draft +Delete a draft +This API deletes an existing draft for the current tenant. + +On success, this endpoint will return an empty response. + +The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-draft) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the draft 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete. + + try: + # Delete a draft + + ConfigurationHubApi(api_client).delete_draft(id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_draft(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-object-mapping +Deletes an object mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-object-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. +Path | object_mapping_id | **str** | True | The id of the object mapping to be deleted. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-uploaded-configuration +Delete an Uploaded Configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-uploaded-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the uploaded configuration. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-deploy +Get a Deploy +This API gets an existing deploy for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-deploy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the deploy. + +### Return type +[**DeployResponse**](../models/deploy-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Gets the details of a deploy. | DeployResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.deploy_response import DeployResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy. + + try: + # Get a Deploy + + results =ConfigurationHubApi(api_client).get_deploy(id) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_deploy(id) + print("The response of ConfigurationHubApi->get_deploy:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-object-mappings +Gets list of object mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-object-mappings) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + +### Return type +[**List[ObjectMappingResponse]**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing object mappings between current org and source org. | List[ObjectMappingResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-uploaded-configuration +Get an Uploaded Configuration +This API gets an existing uploaded configuration for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-uploaded-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the uploaded configuration. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Gets an uploaded configuration details. | BackupResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.backup_response import BackupResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-backups +List Backups +This API gets a list of existing backups for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-backups) + +### 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: **status**: *eq* + +### Return type +[**List[BackupResponse]**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing backups. | List[BackupResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.backup_response import BackupResponse +from pprint import pprint +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 Backups + + results =ConfigurationHubApi(api_client).list_backups() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_backups(filters) + print("The response of ConfigurationHubApi->list_backups:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-deploys +List Deploys +This API gets a list of deploys for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-deploys) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ListDeploys200Response**](../models/list-deploys200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing deploys. | ListDeploys200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Deploys + + results =ConfigurationHubApi(api_client).list_deploys() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_deploys() + print("The response of ConfigurationHubApi->list_deploys:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-drafts +List Drafts +This API gets a list of existing drafts for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-drafts) + +### 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: **status**: *eq* **approvalStatus**: *eq* + +### Return type +[**List[DraftResponse]**](../models/draft-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing drafts. | List[DraftResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.draft_response import DraftResponse +from pprint import pprint +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* **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: **status**: *eq* **approvalStatus**: *eq* (optional) + + try: + # List Drafts + + results =ConfigurationHubApi(api_client).list_drafts() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_drafts(filters) + print("The response of ConfigurationHubApi->list_drafts:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-uploaded-configurations +List Uploaded Configurations +This API gets a list of existing uploaded configurations for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-uploaded-configurations) + +### 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: **status**: *eq* + +### Return type +[**List[BackupResponse]**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing uploaded configurations. | List[BackupResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.backup_response import BackupResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-object-mappings +Bulk updates object mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-object-mappings) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + Body | object_mapping_bulk_patch_request | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The updated object mappings. | ObjectMappingBulkPatchResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest +from sailpoint.v2024.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse +from pprint import pprint +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() + new_object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + results =ConfigurationHubApi(api_client).update_object_mappings(source_org, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md new file mode 100644 index 000000000..3c80e9903 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md @@ -0,0 +1,483 @@ +--- +id: v2024-connector-rule-management +title: Connector_Rule_Management +pagination_label: Connector_Rule_Management +sidebar_label: Connector_Rule_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Connector_Rule_Management', 'V2024Connector_Rule_Management'] +slug: /tools/sdk/python/v2024/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'Connector_Rule_Management', 'V2024Connector_Rule_Management'] +--- + +# sailpoint.v2024.ConnectorRuleManagementApi + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. + +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-rule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule +[**delete-connector-rule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete Connector Rule +[**get-connector-rule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get Connector Rule +[**get-connector-rule-list**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules +[**put-connector-rule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule +[**test-connector-rule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule + + +## create-connector-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. +::: +Create Connector Rule +Create a connector rule from the available types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-rule) + +### 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 | connector_rule_create_request | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | Connector rule to create. + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created connector rule. | ConnectorRuleResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_rule_create_request import ConnectorRuleCreateRequest +from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | Connector rule to create. + + try: + # Create Connector Rule + new_connector_rule_create_request = ConnectorRuleCreateRequest() + new_connector_rule_create_request.from_json(connector_rule_create_request) + results =ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-connector-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. +::: +Delete Connector Rule +Delete the connector rule for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the connector rule 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. | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule 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 Connector Rule + + ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-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. +::: +Get Connector Rule +Get a connector rule by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the connector rule to get. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Connector rule with the given ID. | ConnectorRuleResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule 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 Connector Rule + + results =ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-rule-list +:::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. +::: +List Connector Rules +List existing connector rules. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule-list) + +### 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[ConnectorRuleResponse]**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of connector rules. | List[ConnectorRuleResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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: + # List Connector Rules + + results =ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, limit, offset, count) + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-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. +::: +Update Connector Rule +Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the connector rule to update. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | connector_rule_update_request | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | Connector rule with updated data. + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated connector rule. | ConnectorRuleResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse +from sailpoint.v2024.models.connector_rule_update_request import ConnectorRuleUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + + try: + # Update Connector Rule + + results =ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, new_connector_rule_update_request) + print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-connector-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. +::: +Validate Connector Rule +Detect issues within the connector rule's code to fix and list them. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-connector-rule) + +### 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 | source_code | [**SourceCode**](../models/source-code) | True | Code to validate. + +### Return type +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the code's eligibility as a connector rule. | ConnectorRuleValidationResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_rule_validation_response import ConnectorRuleValidationResponse +from sailpoint.v2024.models.source_code import SourceCode +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | Code to validate. + + try: + # Validate Connector Rule + new_source_code = SourceCode() + new_source_code.from_json(source_code) + results =ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code) + print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md new file mode 100644 index 000000000..fd0caa541 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md @@ -0,0 +1,871 @@ +--- +id: v2024-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Connectors', 'V2024Connectors'] +slug: /tools/sdk/python/v2024/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'V2024Connectors'] +--- + +# sailpoint.v2024.ConnectorsApi + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-connector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector +[**delete-custom-connector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name +[**get-connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name +[**get-connector-correlation-config**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration +[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get Connector List +[**get-connector-source-config**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**get-connector-source-template**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**get-connector-translations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**put-connector-correlation-config**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration +[**put-connector-source-config**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**put-connector-source-template**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**put-connector-translations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**update-connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name + + +## create-custom-connector +Create Custom Connector +Create custom connector. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | v3_create_connector_dto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True | + +### Return type +[**V3ConnectorDto**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | V3ConnectorDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto +from sailpoint.v2024.models.v3_create_connector_dto import V3CreateConnectorDto +from pprint import pprint +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() + new_v3_create_connector_dto.from_json(v3_create_connector_dto) + results =ConnectorsApi(api_client).create_custom_connector(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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-custom-connector +Delete Connector by Script Name +Delete a custom connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-connector +Get Connector by Script Name +Fetches a connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | ConnectorDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_detail import ConnectorDetail +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-correlation-config +Get Connector Correlation Configuration +Fetches a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's correlation config | 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**: application/xml, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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 Correlation Configuration + + results =ConnectorsApi(api_client).get_connector_correlation_config(script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_correlation_config(script_name) + print("The response of ConnectorsApi->get_connector_correlation_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-list) + +### 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + 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 | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**List[V3ConnectorDto]**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | List[V3ConnectorDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-source-config +Get Connector Source Configuration +Fetches a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's source template | 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**: application/xml, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-source-template +Get Connector Source Template +Fetches a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's source template | 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**: application/xml, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-translations +Get Connector Translations +Fetches a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | locale | **str** | True | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's translations | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-correlation-config +Update Connector Correlation Configuration +Update a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + | file | **bytearray** | True | connector correlation config xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.update_detail import UpdateDetail +from pprint import pprint +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 correlation config xml file # bytearray | connector correlation config xml file + + try: + # Update Connector Correlation Configuration + + results =ConnectorsApi(api_client).put_connector_correlation_config(script_name, file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file) + print("The response of ConnectorsApi->put_connector_correlation_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-source-config +Update Connector Source Configuration +Update a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | file | **bytearray** | True | connector source config xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.update_detail import UpdateDetail +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-source-template +Update Connector Source Template +Update a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | file | **bytearray** | True | connector source template xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.update_detail import UpdateDetail +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-translations +Update Connector Translations +Update a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | locale | **str** | True | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.update_detail import UpdateDetail +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-connector +Update Connector by Script Name +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 + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A updated Connector Dto object | ConnectorDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.connectors_api import ConnectorsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_detail import ConnectorDetail +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + + try: + # Update Connector by Script Name + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =ConnectorsApi(api_client).update_connector(script_name, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md new file mode 100644 index 000000000..1ede398bd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md @@ -0,0 +1,1407 @@ +--- +id: v2024-custom-forms +title: Custom_Forms +pagination_label: Custom_Forms +sidebar_label: Custom_Forms +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Custom_Forms', 'V2024Custom_Forms'] +slug: /tools/sdk/python/v2024/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'Custom_Forms', 'V2024Custom_Forms'] +--- + +# sailpoint.v2024.CustomFormsApi + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-form-definition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-file-request**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**create-form-instance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. +[**delete-form-definition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. +[**get-file-from-s3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-form-definition-by-key**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**get-form-instance-by-key**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. +[**get-form-instance-file**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**import-form-definitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. +[**patch-form-definition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**patch-form-instance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. +[**search-form-definitions-by-tenant**](#search-form-definitions-by-tenant) | **GET** `/form-definitions` | Export form definitions by tenant. +[**search-form-element-data-by-element-id**](#search-form-element-data-by-element-id) | **GET** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**search-form-instances-by-tenant**](#search-form-instances-by-tenant) | **GET** `/form-instances` | List form instances by tenant. +[**search-pre-defined-select-options**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. +[**show-preview-data-source**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + + +## create-form-definition +:::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. +::: +Creates a form definition. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition) + +### 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 | body | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form definition | FormDefinitionResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_form_definition_request import CreateFormDefinitionRequest +from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + 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(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-definition-dynamic-schema +:::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. +::: +Generate JSON Schema dynamically. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema) + +### 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 | body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a form elements dynamic schema | FormDefinitionDynamicSchemaResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest +from sailpoint.v2024.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + 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(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-definition-file-request +:::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. +::: +Upload new form definition file. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | FormDefinitionID String specifying FormDefinitionID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + | file | **bytearray** | True | File specifying the multipart + +### Return type +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form definition file | FormDefinitionFileUploadResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +413 | An error with payload size too large | SearchFormDefinitionsByTenant400Response | - | +415 | An error with unsupported media type | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | +503 | An external service is not available | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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 | 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, x_sail_point_experimental, file) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-form-instance +:::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. +::: +Creates a form instance. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-instance) + +### 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 | body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Returns a new form instance | FormInstanceResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_form_instance_request import CreateFormInstanceRequest +from sailpoint.v2024.models.form_instance_response import FormInstanceResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + 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(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-form-definition +:::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. +::: +Deletes a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Returns an empty body | object | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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: + # Deletes a form definition. + + results =CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-form-definitions-by-tenant +:::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. +::: +List form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant) + +### 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 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. + Query | limit | **int** | (optional) (default to 250) | 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. + 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**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | sorters | **str** | (optional) (default to 'name') | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**List[ExportFormDefinitionsByTenant200ResponseInner]**](../models/export-form-definitions-by-tenant200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of form definition objects by tenant used by SP-Config | List[ExportFormDefinitionsByTenant200ResponseInner] | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 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(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-file-from-s3 +:::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. +::: +Download definition file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | FormDefinitionID Form definition ID +Path | file_id | **str** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | bytearray | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | +503 | An external service is not available | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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. + x_sail_point_experimental = 'true' # 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: + # Download definition file by fileId. + + results =CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-form-definition-by-key +:::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. +::: +Return a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a form definition | FormDefinitionResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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: + # Return a form definition. + + results =CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-form-instance-by-key +:::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. +::: +Returns a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | Form instance ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a form instance by its key | FormInstanceResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_instance_response import FormInstanceResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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 a form instance. + + results =CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-form-instance-file +:::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. +::: +Download instance file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | FormInstanceID Form instance ID +Path | file_id | **str** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a file that is referred to by fileID and associated with the formInstanceID | bytearray | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | +503 | An external service is not available | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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. + x_sail_point_experimental = 'true' # 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: + # Download instance file by fileId. + + results =CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-form-definitions +:::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. +::: +Import form definitions from export. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-form-definitions) + +### 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 | body | [**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) | (optional) | Body is the request payload to import form definitions + +### Return type +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returns statuses of those form definition objects imported | ImportFormDefinitions202Response | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner +from sailpoint.v2024.models.import_form_definitions202_response import ImportFormDefinitions202Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + 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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + + + try: + # Import form definitions from export. + + results =CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-form-definition +:::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. +::: +Patch a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | body | **[]Dict[str, object]** | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the form definition updated | FormDefinitionResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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, x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-form-instance +:::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. +::: +Patch a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | Form instance ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | body | **[]Dict[str, object]** | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the form instance updated | FormInstanceResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +409 | An error with the request property conflicts with stored | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_instance_response import FormInstanceResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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, x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-form-definitions-by-tenant +:::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. +::: +Export form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant) + +### 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 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. + Query | limit | **int** | (optional) (default to 250) | 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. + 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**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | sorters | **str** | (optional) (default to 'name') | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of form definitions by tenant | ListFormDefinitionsByTenantResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 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(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-form-element-data-by-element-id +:::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. +::: +Retrieves dynamic data by element. +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-element-data-by-element-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_instance_id | **str** | True | Form instance ID +Path | form_element_id | **str** | True | Form element ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 250) | 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. + 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: **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\")` + Query | query | **str** | (optional) | 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. + +### Return type +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration | ListFormElementDataByElementIDResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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 | 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_element_id, x_sail_point_experimental, ) + # 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, x_sail_point_experimental, limit, filters, query) + print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-form-instances-by-tenant +:::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. +::: +List form instances by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant) + +### 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[ListFormInstancesByTenantResponse]**](../models/list-form-instances-by-tenant-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of form instances by tenant | List[ListFormInstancesByTenantResponse] | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 form instances by tenant. + + results =CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental) + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-pre-defined-select-options +:::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. +::: +List predefined select options. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options) + +### 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 +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a list of available predefined select options | ListPredefinedSelectOptionsResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 predefined select options. + + results =CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental) + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) +``` + + + +[[Back to top]](#) + +## show-preview-data-source +:::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. +::: +Preview form definition data source. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-preview-data-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | form_definition_id | **str** | True | Form definition ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 10) | 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. + 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: **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\")` + Query | query | **str** | (optional) | 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. + Body | form_element_preview_request | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a preview of a form definition data source | PreviewDataSourceResponse | - | +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - | +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - | +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - | +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response | - | +429 | Too many requests | Error | - | +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_forms_api import CustomFormsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.form_element_preview_request import FormElementPreviewRequest +from sailpoint.v2024.models.preview_data_source_response import PreviewDataSourceResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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 = 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, x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, x_sail_point_experimental, limit, filters, query, new_form_element_preview_request) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md new file mode 100644 index 000000000..00353d21d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md @@ -0,0 +1,229 @@ +--- +id: v2024-custom-password-instructions +title: Custom_Password_Instructions +pagination_label: Custom_Password_Instructions +sidebar_label: Custom_Password_Instructions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Custom_Password_Instructions', 'V2024Custom_Password_Instructions'] +slug: /tools/sdk/python/v2024/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'Custom_Password_Instructions', 'V2024Custom_Password_Instructions'] +--- + +# sailpoint.v2024.CustomPasswordInstructionsApi + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/beta/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-password-instructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**get-custom-password-instructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + + +## create-custom-password-instructions +:::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. +::: +Create Custom Password Instructions +This API creates the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-password-instructions) + +### 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 | custom_password_instruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True | + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the custom password instructions. | CustomPasswordInstruction | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_custom_password_instruction.from_json(custom_password_instruction) + results =CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-custom-password-instructions +:::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. +::: +Delete Custom Password Instructions by page ID +This API delete the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-password-instructions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | page_id | **str** | True | The page ID of custom password instructions to delete. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | locale | **str** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + +### 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## get-custom-password-instructions +:::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. +::: +Get Custom Password Instructions by Page ID +This API returns the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-password-instructions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | page_id | **str** | True | The page ID of custom password instructions to query. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | locale | **str** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the custom password instructions. | CustomPasswordInstruction | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md new file mode 100644 index 000000000..33f4dc2b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md @@ -0,0 +1,563 @@ +--- +id: v2024-data-segmentation +title: Data_Segmentation +pagination_label: Data_Segmentation +sidebar_label: Data_Segmentation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Data_Segmentation', 'V2024Data_Segmentation'] +slug: /tools/sdk/python/v2024/methods/data-segmentation +tags: ['SDK', 'Software Development Kit', 'Data_Segmentation', 'V2024Data_Segmentation'] +--- + +# sailpoint.v2024.DataSegmentationApi + This service is responsible for creating segments that will determine how access is delegated to identities +withing the organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-data-segment**](#create-data-segment) | **POST** `/data-segments` | Create Segment +[**delete-data-segment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete Segment by ID +[**get-data-segment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get Segment by ID +[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID +[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity +[**list-data-segments**](#list-data-segments) | **GET** `/data-segments` | Get Segments +[**patch-data-segment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment +[**publish-data-segment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID + + +## create-data-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-data-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | data_segment | [**DataSegment**](../models/data-segment) | True | + +### Return type +[**DataSegment**](../models/data-segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Segment created | DataSegment | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.data_segment import DataSegment +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + data_segment = sailpoint.v2024.DataSegment() # DataSegment | + + try: + # Create Segment + new_data_segment = DataSegment() + new_data_segment.from_json(data_segment) + results =DataSegmentationApi(api_client).create_data_segment(new_data_segment) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).create_data_segment(new_data_segment) + print("The response of DataSegmentationApi->create_data_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-data-segment +:::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. +::: +Delete Segment by ID +This API deletes the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-data-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to delete. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | published | **bool** | (optional) (default to False) | This determines which version of the segment 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID 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') + published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False) + + try: + # Delete Segment by ID + + DataSegmentationApi(api_client).delete_data_segment(id, x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # DataSegmentationApi(api_client).delete_data_segment(id, x_sail_point_experimental, published) + except Exception as e: + print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-data-segment +:::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. +::: +Get Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to retrieve. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**DataSegment**](../models/data-segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Segment | DataSegment | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.data_segment import DataSegment +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + x_sail_point_experimental = 'true' # 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 Segment by ID + + results =DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-data-segment-identity-membership +:::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. +::: +Get SegmentMembership by Identity ID +This API returns the segment membership specified by the given identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment-identity-membership) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | The identity ID to retrieve the segments they are in. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Segment Memberships for specified identity | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. + x_sail_point_experimental = 'true' # 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 SegmentMembership by Identity ID + + results =DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n") + pprint(results) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-data-segmentation-enabled-for-user +:::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. +::: +Is Segmentation enabled by Identity +This API returns whether or not segmentation is enabled for the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segmentation-enabled-for-user) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | The identity ID to retrieve if segmentation is enabled for the identity. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**bool** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns if segmentation is enabled for a specified User | bool | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. + x_sail_point_experimental = 'true' # 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: + # Is Segmentation enabled by Identity + + results =DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") + pprint(results) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-data-segments +:::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. +::: +Get Segments +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-data-segments) + +### 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 | enabled | **bool** | (optional) (default to True) | This boolean indicates whether the segment is currently active. Inactive segments have no effect. + Query | unique | **bool** | (optional) (default to False) | This returns only one record if set to true and that would be the published record if exists. + Query | published | **bool** | (optional) (default to True) | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published + 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, sw* **name**: *eq, in, sw* + +### Return type +[**List[DataSegment]**](../models/data-segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all segments | List[DataSegment] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.data_segment import DataSegment +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) + unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) + published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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 = 'name 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, in, sw* **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, sw* **name**: *eq, in, sw* (optional) + + try: + # Get Segments + + results =DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) + print("The response of DataSegmentationApi->list_data_segments:\n") + pprint(results) + except Exception as e: + print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-data-segment +:::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. +::: +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-data-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to modify. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + 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 * membership * memberFilter * memberSelection * scopes * enabled + +### Return type +[**DataSegment**](../models/data-segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | DataSegment | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.data_segment import DataSegment +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + x_sail_point_experimental = 'true' # 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 = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + request_body = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + + + try: + # Update Segment + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =DataSegmentationApi(api_client).patch_data_segment(id, x_sail_point_experimental, new_request_body) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).patch_data_segment(id, x_sail_point_experimental, new_request_body) + print("The response of DataSegmentationApi->patch_data_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## publish-data-segment +:::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. +::: +Publish segment by ID +This will publish the segment so that it starts applying the segmentation to the desired users if enabled + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/publish-data-segment) + +### 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 | request_body | **[]str** | True | A list of segment ids that you wish to publish + Query | publish_all | **bool** | (optional) (default to True) | This flag decides whether you want to publish all unpublished or a list of specific segment ids + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Segments published | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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] | A list of segment ids that you wish to publish + request_body = ['request_body_example'] # List[str] | A list of segment ids that you wish to publish + + publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) + + try: + # Publish segment by ID + new_request_body = RequestBody() + new_request_body.from_json(request_body) + DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental, new_request_body, ) + # Below is a request that includes all optional parameters + # DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental, new_request_body, publish_all) + except Exception as e: + print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md new file mode 100644 index 000000000..573b96d9b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md @@ -0,0 +1,666 @@ +--- +id: v2024-dimensions +title: Dimensions +pagination_label: Dimensions +sidebar_label: Dimensions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Dimensions', 'V2024Dimensions'] +slug: /tools/sdk/python/v2024/methods/dimensions +tags: ['SDK', 'Software Development Kit', 'Dimensions', 'V2024Dimensions'] +--- + +# sailpoint.v2024.DimensionsApi + Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions 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. Dimension represent access selectively based on the evaluation of contextual information that is available or provided. Each Dimension include context attributes and access selection expressions which map criteria to access right assignments. Each dimension can contain up to 5 context attributes. Dynamic Access Roles represent the broadest level of access and often group access profiles ,entitlements and dimensions.Each Dynamic Access Role may contain one or more Dimensions. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a Dimension +[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) +[**delete-dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension +[**get-dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. +[**get-dimension-entitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements +[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles +[**list-dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions +[**patch-dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension + + +## create-dimension +Create a Dimension +This API creates a dimension. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. +Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-dimension) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. + Body | dimension | [**Dimension**](../models/dimension) | True | + +### Return type +[**Dimension**](../models/dimension) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Dimension created | Dimension | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dimension import Dimension +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension = { + "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" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "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.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } # Dimension | + + try: + # Create a Dimension + new_dimension = Dimension() + new_dimension.from_json(dimension) + results =DimensionsApi(api_client).create_dimension(role_id, new_dimension) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).create_dimension(role_id, new_dimension) + print("The response of DimensionsApi->create_dimension:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-bulk-dimensions +Delete Dimension(s) +This endpoint initiates a bulk deletion of one or more dimensions. +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 token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions 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-dimensions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimensions. + Body | dimension_bulk_delete_request | [**DimensionBulkDeleteRequest**](../models/dimension-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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dimension_bulk_delete_request import DimensionBulkDeleteRequest +from sailpoint.v2024.models.task_result_dto import TaskResultDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. + dimension_bulk_delete_request = { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # DimensionBulkDeleteRequest | + + try: + # Delete Dimension(s) + new_dimension_bulk_delete_request = DimensionBulkDeleteRequest() + new_dimension_bulk_delete_request.from_json(dimension_bulk_delete_request) + results =DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request) + print("The response of DimensionsApi->delete_bulk_dimensions:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-dimension +Delete a Dimension +This API deletes a Dimension 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/Entitlements included in the Dimension 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-dimension) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. +Path | dimension_id | **str** | True | Id of the Dimension + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + + try: + # Delete a Dimension + + DimensionsApi(api_client).delete_dimension(role_id, dimension_id) + # Below is a request that includes all optional parameters + # DimensionsApi(api_client).delete_dimension(role_id, dimension_id) + except Exception as e: + print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-dimension +Get a Dimension under Role. +This API returns a Dimension 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 or Entitlements included in the Dimension or Parent 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-dimension) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. +Path | dimension_id | **str** | True | Id of the Dimension + +### Return type +[**Dimension**](../models/dimension) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Dimension | Dimension | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dimension import Dimension +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + + try: + # Get a Dimension under Role. + + results =DimensionsApi(api_client).get_dimension(role_id, dimension_id) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).get_dimension(role_id, dimension_id) + print("The response of DimensionsApi->get_dimension:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-dimension-entitlements +List Dimension's Entitlements +This API lists the Entitlements associated with a given dimension. + +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/get-dimension-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. +Path | dimension_id | **str** | True | Id of the Dimension + 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, 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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* (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 Dimension's Entitlements + + results =DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, ) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->get_dimension_entitlements:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-dimension-access-profiles +List Dimension's Access Profiles +This API lists the Access Profiles associated with a given Dimension + +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/list-dimension-access-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. +Path | dimension_id | **str** | True | Id of the Dimension + 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, 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, created, modified** + +### Return type +[**List[AccessProfile]**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Access Profiles | List[AccessProfile] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_profile import AccessProfile +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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 = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # 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* **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* **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, 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 Dimension's Access Profiles + + results =DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, ) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimension_access_profiles:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-dimensions +List Dimensions +This API returns a list of dimensions under a specified role. + +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-dimensions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. + 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* + 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** + +### Return type +[**List[Dimension]**](../models/dimension) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Dimensions | List[Dimension] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dimension import Dimension +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + 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 = 'id eq \'2c918086749d78830174a1a40e121518\'' # 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* (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* (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) + + try: + # List Dimensions + + results =DimensionsApi(api_client).list_dimensions(role_id, ) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimensions:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-dimension +Patch a specified Dimension +This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** +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/entitlements included in the dimension 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. +When you use this API to modify a dimension'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-dimension) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | role_id | **str** | True | Parent Role Id of the dimension. +Path | dimension_id | **str** | True | Id of the Dimension + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Dimension**](../models/dimension) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Dimension as updated. | Dimension | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.dimensions_api import DimensionsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dimension import Dimension +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + [{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Dimension + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation) + print("The response of DimensionsApi->patch_dimension:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md new file mode 100644 index 000000000..435ac9eda --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md @@ -0,0 +1,948 @@ +--- +id: v2024-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Entitlements', 'V2024Entitlements'] +slug: /tools/sdk/python/v2024/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'V2024Entitlements'] +--- + +# sailpoint.v2024.EntitlementsApi + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +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. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**get-entitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement +[**get-entitlement-request-config**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**list-entitlement-children**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children +[**list-entitlement-parents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents +[**list-entitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. +[**patch-entitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement +[**put-entitlement-request-config**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**reset-source-entitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list + + +## create-access-model-metadata-for-entitlement +:::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. +::: +Add metadata to an entitlement. +Add single Access Model Metadata to an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-model-metadata-for-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The entitlement id. +Path | attribute_key | **str** | True | Technical name of the Attribute. +Path | attribute_value | **str** | True | Technical name of the Attribute Value. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | OK | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, attribute_key, attribute_value, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-model-metadata-from-entitlement +:::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. +::: +Remove metadata from an entitlement. +Remove single Access Model Metadata from an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-model-metadata-from-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The entitlement id. +Path | attribute_key | **str** | True | Technical name of the Attribute. +Path | attribute_value | **str** | True | Technical name of the Attribute Value. + | 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 | OK | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, attribute_key, attribute_value, 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) +``` + + + +[[Back to top]](#) + +## get-entitlement +:::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. +::: +Get an entitlement +This API returns an entitlement by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The entitlement ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An entitlement | 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-request-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. +::: +Get Entitlement Request Config +This API returns the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement Id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An Entitlement Request Config | EntitlementRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement_request_config import EntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-entitlements-by-source +:::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. +::: +Aggregate Entitlements +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-by-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + | csv_file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate. + +### Return type +[**LoadEntitlementTask**](../models/load-entitlement-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Aggregate Entitlements Task | LoadEntitlementTask | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-entitlement-children +:::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. +::: +List of entitlements children +This API returns a list of all child entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-children) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement Id + | 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 | 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, type, attribute, value, source.id** + 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* **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* + +### Return type +[**List[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of entitlements children from an entitlement | 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-entitlement-parents +:::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. +::: +List of entitlements parents +This API returns a list of all parent entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-parents) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement Id + | 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 | 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, type, attribute, value, source.id** + 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* **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* + +### Return type +[**List[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of entitlements parents from an entitlement | 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-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. +::: +Gets a list of entitlements. +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements) + +### 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 | account_id | **str** | (optional) | 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). + Query | segmented_for_identity | **str** | (optional) | 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. + Query | for_segment_ids | **str** | (optional) | 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). + Query | include_unsegmented | **bool** | (optional) (default to True) | 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. + 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: **id, name, created, modified, type, attribute, value, source.id, requestable** + 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* **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* + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-entitlement +:::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. +::: +Patch an entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-entitlement) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the entitlement 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) | (optional) | + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the entitlement as updated. | 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch an entitlement + + results =EntitlementsApi(api_client).patch_entitlement(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-entitlement-request-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. +::: +Replace Entitlement Request Config +This API replaces the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Entitlement ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | entitlement_request_config | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the entitlement request config as updated. | EntitlementRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement_request_config import EntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_entitlement_request_config.from_json(entitlement_request_config) + results =EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reset-source-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. +::: +Reset Source Entitlements +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`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-source-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of source for the entitlement reset + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Entitlement source reset task result | EntitlementSourceResetBaseReferenceDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-entitlements-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. +::: +Bulk update an entitlement list +"This API applies an update to every entitlement of the list.\n\nThe\ + \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\ + \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\ + \ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\ + value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\ + : boolean }**`" + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-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 | entitlement_bulk_update_request | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.entitlements_api import EntitlementsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, 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) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md new file mode 100644 index 000000000..da786478c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md @@ -0,0 +1,217 @@ +--- +id: v2024-global-tenant-security-settings +title: Global_Tenant_Security_Settings +pagination_label: Global_Tenant_Security_Settings +sidebar_label: Global_Tenant_Security_Settings +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Global_Tenant_Security_Settings', 'V2024Global_Tenant_Security_Settings'] +slug: /tools/sdk/python/v2024/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'Global_Tenant_Security_Settings', 'V2024Global_Tenant_Security_Settings'] +--- + +# sailpoint.v2024.GlobalTenantSecuritySettingsApi + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-auth-org-network-config**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-network-config**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**patch-auth-org-network-config**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. + + +## create-auth-org-network-config +Create security network configuration. +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-auth-org-network-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | network_configuration | [**NetworkConfiguration**](../models/network-configuration) | True | 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. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Network configuration for the tenant. | NetworkConfiguration | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.network_configuration import NetworkConfiguration +from pprint import pprint +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() + new_network_configuration.from_json(network_configuration) + results =GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-network-config +Get security network configuration. +This API returns the details of an org's network auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-network-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Network configuration for the tenant's auth org. | NetworkConfiguration | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.network_configuration import NetworkConfiguration +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-network-config +Update security network configuration. +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-network-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org network configuration. | NetworkConfiguration | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.network_configuration import NetworkConfiguration +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md new file mode 100644 index 000000000..a6180e7df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md @@ -0,0 +1,759 @@ +--- +id: v2024-governance-groups +title: Governance_Groups +pagination_label: Governance_Groups +sidebar_label: Governance_Groups +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Governance_Groups', 'V2024Governance_Groups'] +slug: /tools/sdk/python/v2024/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'Governance_Groups', 'V2024Governance_Groups'] +--- + +# sailpoint.v2024.GovernanceGroupsApi + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. +[**delete-workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group +[**delete-workgroup-members**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**get-workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id +[**list-connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**list-workgroup-members**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**list-workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups +[**patch-workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group +[**update-workgroup-members**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + + +## create-workgroup +:::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. +::: +Create a new Governance Group. +This API creates a new Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup) + +### 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 | workgroup_dto | [**WorkgroupDto**](../models/workgroup-dto) | True | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Governance Group object created. | WorkgroupDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_workgroup_dto.from_json(workgroup_dto) + results =GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workgroup +:::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. +::: +Delete a Governance Group +This API deletes a Governance Group by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Governance Group + | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## delete-workgroup-members +:::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. +::: +Remove members from Governance Group +This API removes one or more members from a Governance Group. A +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup-members) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | identity_preview_response_identity | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | True | List of identities to be removed from a Governance Group members list. + +### Return type +[**List[WorkgroupMemberDeleteItem]**](../models/workgroup-member-delete-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | List of deleted and not deleted identities from Governance Group members list. | List[WorkgroupMemberDeleteItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_preview_response_identity import IdentityPreviewResponseIdentity +from sailpoint.v2024.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.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() + new_identity_preview_response_identity.from_json(identity_preview_response_identity) + results =GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workgroups-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. +::: +Delete Governance Group(s) + +This API initiates a bulk deletion of one or more Governance Groups. + +> 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. + +> 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. + +> 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. + +> 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. + +> **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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroups-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 | workgroup_bulk_delete_request | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | True | + +### Return type +[**List[WorkgroupDeleteItem]**](../models/workgroup-delete-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | Governance Group bulk delete response. | List[WorkgroupDeleteItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest +from sailpoint.v2024.models.workgroup_delete_item import WorkgroupDeleteItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + results =GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workgroup +:::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. +::: +Get Governance Group by Id +This API returns a Governance Groups by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Governance Group + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Governance Group | WorkgroupDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-connections +:::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. +::: +List connections for Governance Group +This API returns list of connections associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + | 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 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 | 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** + +### Return type +[**List[WorkgroupConnectionDto]**](../models/workgroup-connection-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List all connections associated with a Governance Group. | List[WorkgroupConnectionDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workgroup_connection_dto import WorkgroupConnectionDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workgroup-members +:::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. +::: +List Governance Group Members +This API returns list of members associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroup-members) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + | 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 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 | 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** + +### Return type +[**List[ListWorkgroupMembers200ResponseInner]**](../models/list-workgroup-members200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List all members associated with a Governance Group. | List[ListWorkgroupMembers200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workgroups +:::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. +::: +List Governance Groups +This API returns list of Governance Groups + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups) + +### 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 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 | 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *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, created, modified, id, description** + +### Return type +[**List[WorkgroupDto]**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Governance Groups | List[WorkgroupDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-workgroup +:::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. +::: +Patch a Governance Group +This API updates an existing governance group by ID. The following fields and objects are patchable: +* name +* description +* owner + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workgroup) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Governance Group + | 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) | (optional) | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Governance Group. | WorkgroupDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.workgroup_dto import WorkgroupDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + + try: + # Patch a Governance Group + + results =GovernanceGroupsApi(api_client).patch_workgroup(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-workgroup-members +:::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. +::: +Add members to Governance Group +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** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-workgroup-members) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | workgroup_id | **str** | True | ID of the Governance Group. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | identity_preview_response_identity | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | True | List of identities to be added to a Governance Group members list. + +### Return type +[**List[WorkgroupMemberAddItem]**](../models/workgroup-member-add-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +207 | List of added and not added identities into Governance Group members list. | List[WorkgroupMemberAddItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_preview_response_identity import IdentityPreviewResponseIdentity +from sailpoint.v2024.models.workgroup_member_add_item import WorkgroupMemberAddItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.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() + new_identity_preview_response_identity.from_json(identity_preview_response_identity) + results =GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md new file mode 100644 index 000000000..e229a6af8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md @@ -0,0 +1,747 @@ +--- +id: v2024-iai-access-request-recommendations +title: IAI_Access_Request_Recommendations +pagination_label: IAI_Access_Request_Recommendations +sidebar_label: IAI_Access_Request_Recommendations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Access_Request_Recommendations', 'V2024IAI_Access_Request_Recommendations'] +slug: /tools/sdk/python/v2024/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAI_Access_Request_Recommendations', 'V2024IAI_Access_Request_Recommendations'] +--- + +# sailpoint.v2024.IAIAccessRequestRecommendationsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Notification of Ignored Access Request Recommendations +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Notification of Requested Access Request Recommendations +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk +[**get-access-request-recommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations +[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config + + +## add-access-request-recommendations-ignored-item +:::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. +::: +Notification of Ignored Access Request Recommendations +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-ignored-item) + +### 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 | access_request_recommendation_action_item_dto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Recommendation successfully stored as ignored. | AccessRequestRecommendationActionItemResponseDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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: + # Notification of Ignored Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## add-access-request-recommendations-requested-item +:::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. +::: +Notification of Requested Access Request Recommendations +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-requested-item) + +### 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 | access_request_recommendation_action_item_dto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Notification successfully acknowledged. | AccessRequestRecommendationActionItemResponseDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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: + # Notification of Requested Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-item +:::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. +::: +Notification of Viewed Access Request Recommendations +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-item) + +### 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 | access_request_recommendation_action_item_dto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Recommendation successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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: + # Notification of Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-items +:::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. +::: +Notification of Viewed Access Request Recommendations in Bulk +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-items) + +### 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 | access_request_recommendation_action_item_dto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity. + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Recommendations successfully stored as viewed. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + + try: + # Notification of Viewed Access Request Recommendations in Bulk + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto() + new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations +:::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. +::: +Identity Access Request Recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations) + +### 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 | identity_id | **str** | (optional) (default to 'me') | Get access request recommendations for an identityId. *me* indicates the current user. + Query | limit | **int** | (optional) (default to 15) | Max number of results to return. + 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 | include_translation_messages | **bool** | (optional) (default to False) | If *true* it will populate a list of translation messages in the response. + 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + +### Return type +[**List[AccessRequestRecommendationItemDetail]**](../models/access-request-recommendation-item-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access request recommendations for the identityId | List[AccessRequestRecommendationItemDetail] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 = '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: **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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-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. +::: +Get Access Request Recommendations config +This API returns the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-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 +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-ignored-items +:::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. +::: +List of Ignored Access Request Recommendations +This API returns the list of ignored access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-ignored-items) + +### 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id, access.type, identityId, timestamp** + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns list of ignored access request recommendations. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 of Ignored Access Request Recommendations + + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-requested-items +:::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. +::: +List of Requested Access Request Recommendations +This API returns a list of requested access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-requested-items) + +### 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id, access.type, identityId, timestamp** + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the list of requested access request recommendations. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 = '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: **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 of Requested Access Request Recommendations + + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-recommendations-viewed-items +:::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. +::: +List of Viewed Access Request Recommendations +This API returns the list of viewed access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-viewed-items) + +### 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id, access.type, identityId, timestamp** + +### Return type +[**List[AccessRequestRecommendationActionItemResponseDto]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns list of viewed access request recommendations. | List[AccessRequestRecommendationActionItemResponseDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 = '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: **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 of Viewed Access Request Recommendations + + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-access-request-recommendations-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. +::: +Update Access Request Recommendations config +This API updates the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-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 | access_request_recommendation_config_dto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant. + +### Return type +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_access_request_recommendation_config_dto.from_json(access_request_recommendation_config_dto) + results =IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md new file mode 100644 index 000000000..2f2b471bd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md @@ -0,0 +1,241 @@ +--- +id: v2024-iai-common-access +title: IAI_Common_Access +pagination_label: IAI_Common_Access +sidebar_label: IAI_Common_Access +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Common_Access', 'V2024IAI_Common_Access'] +slug: /tools/sdk/python/v2024/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAI_Common_Access', 'V2024IAI_Common_Access'] +--- + +# sailpoint.v2024.IAICommonAccessApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-common-access**](#create-common-access) | **POST** `/common-access` | Create common access items +[**get-common-access**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access +[**update-common-access-status-in-bulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status + + +## create-common-access +:::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. +::: +Create common access items +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-common-access) + +### 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 | common_access_item_request | [**CommonAccessItemRequest**](../models/common-access-item-request) | True | + +### Return type +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returns details of the common access classification request. | CommonAccessItemResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.common_access_item_request import CommonAccessItemRequest +from sailpoint.v2024.models.common_access_item_response import CommonAccessItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_common_access_item_request.from_json(common_access_item_request) + results =IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-common-access +:::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. +::: +Get a paginated list of common access +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-common-access) + +### 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 | 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **access.name, status** By default the common access items are sorted by name, ascending. + +### Return type +[**List[CommonAccessResponse]**](../models/common-access-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of common access for a customer. | List[CommonAccessResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.common_access_response import CommonAccessResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-common-access-status-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. +::: +Bulk update common access status +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-common-access-status-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 | common_access_id_status | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | True | Confirm or deny in bulk the common access ids that are (or aren't) common access + +### 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.common_access_id_status import CommonAccessIDStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # 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() + new_common_access_id_status.from_json(common_access_id_status) + results =IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md new file mode 100644 index 000000000..26adf6d55 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md @@ -0,0 +1,662 @@ +--- +id: v2024-iai-outliers +title: IAI_Outliers +pagination_label: IAI_Outliers +sidebar_label: IAI_Outliers +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Outliers', 'V2024IAI_Outliers'] +slug: /tools/sdk/python/v2024/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAI_Outliers', 'V2024IAI_Outliers'] +--- + +# sailpoint.v2024.IAIOutliersApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-outliers-zip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary +[**get-identity-outliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**ignore-identity-outliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore +[**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore + + +## export-outliers-zip +:::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. +::: +IAI Identity Outliers Export +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). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-outliers-zip) + +### 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 | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-outlier-snapshots +:::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. +::: +IAI Identity Outliers Summary +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outlier-snapshots) + +### 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 | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + 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: **snapshotDate**: *ge, le* + 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: **snapshotDate** + +### Return type +[**List[OutlierSummary]**](../models/outlier-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers | List[OutlierSummary] | * X-Total-Count - The total result count. | +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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.outlier_summary import OutlierSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-outliers +:::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. +::: +IAI Get Identity Outliers +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outliers) + +### 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 | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* + 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: **firstDetectionDate, attributes, score** + +### Return type +[**List[Outlier]**](../models/outlier) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object contains information about outliers. | List[Outlier] | * 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.outlier import Outlier +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-latest-identity-outlier-snapshots +:::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. +::: +IAI Identity Outliers Latest Summary +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-latest-identity-outlier-snapshots) + +### 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 | type | **str** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +[**List[LatestOutlierSummary]**](../models/latest-outlier-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | List[LatestOutlierSummary] | - | +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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.latest_outlier_summary import LatestOutlierSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-outlier-contributing-feature-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. +::: +Get identity outlier contibuting feature summary +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-outlier-contributing-feature-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | outlier_feature_id | **str** | True | Contributing feature id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns selected contributing feature summary for an outlier. | OutlierFeatureSummary | * accept-language - The locale to use for translations | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.outlier_feature_summary import OutlierFeatureSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-peer-group-outliers-contributing-features +:::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. +::: +Get identity outlier's contibuting features +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers-contributing-features) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | outlier_id | **str** | True | The outlier id + | 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 | include_translation_messages | **str** | (optional) | Whether or not to include translation messages object in returned response + 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: **importance** + +### Return type +[**List[OutlierContributingFeature]**](../models/outlier-contributing-feature) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. | List[OutlierContributingFeature] | * X-Total-Count - The total result count. * accept-language - The locale to use for translations | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.outlier_contributing_feature import OutlierContributingFeature +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) +``` + + + +[[Back to top]](#) + +## ignore-identity-outliers +:::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. +::: +IAI Identity Outliers Ignore +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/ignore-identity-outliers) + +### 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 | request_body | **[]str** | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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] | + request_body = ['request_body_example'] # List[str] | + + + try: + # IAI Identity Outliers Ignore + new_request_body = RequestBody() + new_request_body.from_json(request_body) + IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, 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) +``` + + + +[[Back to top]](#) + +## list-outliers-contributing-feature-access-items +:::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. +::: +Gets a list of access items associated with each identity outlier contributing feature +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-outliers-contributing-feature-access-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | outlier_id | **str** | True | The outlier id +Path | contributing_feature_name | **str** | True | The name of contributing feature + | 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 | access_type | **str** | (optional) | The type of access item for the identity outlier contributing feature. If not provided, it returns all. + 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: **displayName** + +### Return type +[**List[OutliersContributingFeatureAccessItems]**](../models/outliers-contributing-feature-access-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of access items. | List[OutliersContributingFeatureAccessItems] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, contributing_feature_name, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## un-ignore-identity-outliers +:::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. +::: +IAI Identity Outliers Unignore +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/un-ignore-identity-outliers) + +### 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 | request_body | **[]str** | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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] | + request_body = ['request_body_example'] # List[str] | + + + try: + # IAI Identity Outliers Unignore + new_request_body = RequestBody() + new_request_body.from_json(request_body) + IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, 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) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md new file mode 100644 index 000000000..bde4d97c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md @@ -0,0 +1,95 @@ +--- +id: v2024-iai-peer-group-strategies +title: IAI_Peer_Group_Strategies +pagination_label: IAI_Peer_Group_Strategies +sidebar_label: IAI_Peer_Group_Strategies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Peer_Group_Strategies', 'V2024IAI_Peer_Group_Strategies'] +slug: /tools/sdk/python/v2024/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAI_Peer_Group_Strategies', 'V2024IAI_Peer_Group_Strategies'] +--- + +# sailpoint.v2024.IAIPeerGroupStrategiesApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-peer-group-outliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + + +## get-peer-group-outliers +:::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. +::: +Identity Outliers List +-- 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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | strategy | **str** | True | The strategy used to create peer groups. Currently, 'entitlement' is supported. + | 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. + +### Return type +[**List[PeerGroupMember]**](../models/peer-group-member) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identities that are not included in peer groups. | List[PeerGroupMember] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.peer_group_member import PeerGroupMember +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md new file mode 100644 index 000000000..5733df79f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md @@ -0,0 +1,238 @@ +--- +id: v2024-iai-recommendations +title: IAI_Recommendations +pagination_label: IAI_Recommendations +sidebar_label: IAI_Recommendations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Recommendations', 'V2024IAI_Recommendations'] +slug: /tools/sdk/python/v2024/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAI_Recommendations', 'V2024IAI_Recommendations'] +--- + +# sailpoint.v2024.IAIRecommendationsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object +[**get-recommendations-config**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values +[**update-recommendations-config**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values + + +## get-recommendations +:::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. +::: +Returns a Recommendation Based on Object +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations) + +### 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 | recommendation_request_dto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True | + +### Return type +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The recommendations for a customer | RecommendationResponseDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.recommendation_request_dto import RecommendationRequestDto +from sailpoint.v2024.models.recommendation_response_dto import RecommendationResponseDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 a Recommendation Based on Object + new_recommendation_request_dto = RecommendationRequestDto() + new_recommendation_request_dto.from_json(recommendation_request_dto) + results =IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-recommendations-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. +::: +Get certification recommendation config values +Retrieves configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations-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 +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Cert recommendation configuration attributes | RecommendationConfigDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfigDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-recommendations-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. +::: +Update certification recommendation config values +Updates configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-recommendations-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 | recommendation_config_dto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True | + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Cert recommendation configuration attributes after update | RecommendationConfigDto | - | +400 | Client Error - 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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfigDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_recommendation_config_dto.from_json(recommendation_config_dto) + results =IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md new file mode 100644 index 000000000..2417eff1a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md @@ -0,0 +1,1866 @@ +--- +id: v2024-iai-role-mining +title: IAI_Role_Mining +pagination_label: IAI_Role_Mining +sidebar_label: IAI_Role_Mining +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IAI_Role_Mining', 'V2024IAI_Role_Mining'] +slug: /tools/sdk/python/v2024/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAI_Role_Mining', 'V2024IAI_Role_Mining'] +--- + +# sailpoint.v2024.IAIRoleMiningApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-potential-role-provision-request**](#create-potential-role-provision-request) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**create-role-mining-sessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session +[**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**get-entitlements-potential-role**](#get-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**get-excluded-entitlements-potential-role**](#get-excluded-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**get-identities-potential-role**](#get-identities-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**get-potential-role**](#get-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieves a specific potential role +[**get-potential-role-applications**](#get-potential-role-applications) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**get-potential-role-entitlements**](#get-potential-role-entitlements) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**get-potential-role-source-identity-usage**](#get-potential-role-source-identity-usage) | **GET** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**get-potential-role-summaries**](#get-potential-role-summaries) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieves all potential role summaries +[**get-role-mining-potential-role**](#get-role-mining-potential-role) | **GET** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-session**](#get-role-mining-session) | **GET** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**get-role-mining-session-status**](#get-role-mining-session-status) | **GET** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**get-role-mining-sessions**](#get-role-mining-sessions) | **GET** `/role-mining-sessions` | Retrieves all role mining sessions +[**get-saved-potential-roles**](#get-saved-potential-roles) | **GET** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**patch-potential-role**](#patch-potential-role) | **PATCH** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role +[**patch-potential-role-0**](#patch-potential-role-0) | **PATCH** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**patch-role-mining-session**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**update-entitlements-potential-role**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + + +## create-potential-role-provision-request +:::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. +::: +Create request to provision a potential role into an actual role. +This method starts a job to provision a potential role + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-potential-role-provision-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | min_entitlement_popularity | **int** | (optional) (default to 0) | Minimum popularity required for an entitlement to be included in the provisioned role. + Query | include_common_access | **bool** | (optional) (default to True) | Boolean determining whether common access entitlements will be included in the provisioned role. + Body | role_mining_potential_role_provision_request | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role + +### Return type +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. Returns a potential role summary including the status of the provison request | RoleMiningPotentialRoleSummary | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest +from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-role-mining-sessions +:::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. +::: +Create a role mining session +This submits a create role mining session request to the role mining application. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-mining-sessions) + +### 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 | role_mining_session_dto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Submitted a role mining session request | RoleMiningSessionResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto +from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_role_mining_session_dto.from_json(role_mining_session_dto) + results =IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## download-role-mining-potential-role-zip +:::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. +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads a completed export of information for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-mining-potential-role-zip) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session +Path | export_id | **str** | True | The id of a previously run export job for this potential role + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, export_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-role-mining-potential-role +:::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. +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | 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 | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-role-mining-potential-role-async +:::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. +::: +Asynchronously export details for a potential role in a role mining session and upload to S3 +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | role_mining_potential_role_export_request | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) | + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Job Submitted. Returns a reportId that can be used to download the zip once complete | RoleMiningPotentialRoleExportResponse | - | +400 | Client Error - 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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest +from sailpoint.v2024.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-role-mining-potential-role-status +:::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. +::: +Retrieve status of a potential role export job +This endpoint retrieves information about the current status of a potential role export. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session +Path | export_id | **str** | True | The id of a previously run export job for this potential role + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Success. Returns the current status of this export | RoleMiningPotentialRoleExportResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, export_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-all-potential-role-summaries +:::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. +::: +Retrieves all potential role summaries +Returns all potential role summaries that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-all-potential-role-summaries) + +### 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 | 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: **createdDate, identityCount, entitlementCount, freshness, quality** + 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: **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* + 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[RoleMiningPotentialRoleSummary]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns all potential role summaries that match the query parameters. | List[RoleMiningPotentialRoleSummary] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-distribution-potential-role +:::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. +::: +Retrieves entitlement popularity distribution for a potential role in a role mining session +This method returns entitlement popularity distribution for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-distribution-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | include_common_access | **bool** | (optional) | Boolean determining whether common access entitlements will be included or not + +### Return type +**Dict[str, int]** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a map containing entitlement popularity distribution for a potential role. | Dict[str, int] | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlements-potential-role +:::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. +::: +Retrieves entitlements for a potential role in a role mining session +This method returns entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | include_common_access | **bool** | (optional) (default to True) | Boolean determining whether common access entitlements will be included or not + 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: **popularity, entitlementName, applicationName** The default sort is **popularity** 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: **applicationName**: *sw* **entitlementRef.name**: *sw* + 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[RoleMiningEntitlement]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of entitlements for a potential role. | List[RoleMiningEntitlement] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-excluded-entitlements-potential-role +:::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. +::: +Retrieves excluded entitlements for a potential role in a role mining session +This method returns excluded entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-excluded-entitlements-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | 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: **popularity** + 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: **applicationName**: *sw* **entitlementRef.name**: *sw* + 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[RoleMiningEntitlement]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of excluded entitlements for a potential roles. | List[RoleMiningEntitlement] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identities-potential-role +:::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. +::: +Retrieves identities for a potential role in a role mining session +This method returns identities for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identities-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | 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: **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* + 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[RoleMiningIdentity]**](../models/role-mining-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of identities for a potential role. | List[RoleMiningIdentity] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_identity import RoleMiningIdentity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role +:::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. +::: +Retrieves a specific potential role +This method returns a specific potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-applications +:::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. +::: +Retrieves the applications of a potential role for a role mining session +This method returns the applications of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-applications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | 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: **applicationName**: *sw* + 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[RoleMiningPotentialRoleApplication]**](../models/role-mining-potential-role-application) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential roles for a role mining session. | List[RoleMiningPotentialRoleApplication] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-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. +::: +Retrieves the entitlements of a potential role for a role mining session +This method returns the entitlements of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | 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: **entitlementRef.name**: *sw* + 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[RoleMiningPotentialRoleEntitlements]**](../models/role-mining-potential-role-entitlements) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns the entitlements of a potential role for a role mining session. session. | List[RoleMiningPotentialRoleEntitlements] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, potential_role_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-source-identity-usage +:::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. +::: +Retrieves potential role source usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-source-identity-usage) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | potential_role_id | **str** | True | A potential role id +Path | source_id | **str** | True | A source 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 is supported for the following fields: **displayName, email, usageCount** + 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[RoleMiningPotentialRoleSourceUsage]**](../models/role-mining-potential-role-source-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of source usage for the identities in a potential role. | List[RoleMiningPotentialRoleSourceUsage] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-potential-role-summaries +:::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. +::: +Retrieves all potential role summaries +This method returns the potential role summaries for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session 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: **createdDate** + 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: **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* + 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[RoleMiningPotentialRoleSummary]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential role summaries for a role mining session. | List[RoleMiningPotentialRoleSummary] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-potential-role +:::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. +::: +Retrieves a specific potential role +This method returns a specific potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | potential_role_id | **str** | True | A potential role id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-session +:::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. +::: +Get a role mining session +The method retrieves a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id to be retrieved. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns a role mining session | RoleMiningSessionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessionResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-session-status +:::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. +::: +Get role mining session status state +This method returns a role mining session status for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns session status | RoleMiningSessionStatus | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_session_status import RoleMiningSessionStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-mining-sessions +:::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. +::: +Retrieves all role mining sessions +Returns all role mining sessions that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-sessions) + +### 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 | 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: **saved**: *eq* **name**: *eq, 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: **createdBy, createdDate** + 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[RoleMiningSessionDto]**](../models/role-mining-session-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns all role mining sessions that match the query parameters. | List[RoleMiningSessionDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-saved-potential-roles +:::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. +::: +Retrieves all saved potential roles +This method returns all saved potential roles (draft roles). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-potential-roles) + +### 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 | 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 is supported for the following fields: **modified** + 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[RoleMiningSessionDraftRoleDto]**](../models/role-mining-session-draft-role-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of draft roles for a role mining session. | List[RoleMiningSessionDraftRoleDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-potential-role +:::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. +::: +Update a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | The potential role summary id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | patch_potential_role_request_inner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{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] | + 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() + new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + results =IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-potential-role-0 +:::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. +::: +Update a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role-0) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | The potential role summary id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | patch_potential_role_request_inner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{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] | + 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() + new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + results =IAIRoleMiningApi(api_client).patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-role-mining-session +:::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. +::: +Patch a role mining session +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role-mining-session) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id to be patched + | 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 | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + +### 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-entitlements-potential-role +:::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. +::: +Edit entitlements for a potential role to exclude some entitlements +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-potential-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | session_id | **str** | True | The role mining session id +Path | potential_role_id | **str** | True | A potential role id in a role mining session + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | role_mining_potential_role_edit_entitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Adds or removes entitlements from a potential role's entitlement exclusion list. | RoleMiningPotentialRole | - | +400 | Client Error - 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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole +from sailpoint.v2024.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + results =IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md new file mode 100644 index 000000000..03099705a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md @@ -0,0 +1,158 @@ +--- +id: v2024-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Icons', 'V2024Icons'] +slug: /tools/sdk/python/v2024/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'V2024Icons'] +--- + +# sailpoint.v2024.IconsApi + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon +[**set-icon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon + + +## delete-icon +:::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. +::: +Delete an icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-icon) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | object_type | **str** | True | Object type. Available options ['application'] +Path | object_id | **str** | True | Object id. + | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.icons_api import IconsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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_id, 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) +``` + + + +[[Back to top]](#) + +## set-icon +:::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. +::: +Update an icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-icon) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | object_type | **str** | True | Object type. Available options ['application'] +Path | object_id | **str** | True | Object id. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + | image | **bytearray** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + +### Return type +[**SetIcon200Response**](../models/set-icon200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Icon updated | SetIcon200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.icons_api import IconsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.set_icon200_response import SetIcon200Response +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md new file mode 100644 index 000000000..9f9f058ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md @@ -0,0 +1,799 @@ +--- +id: v2024-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identities', 'V2024Identities'] +slug: /tools/sdk/python/v2024/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'V2024Identities'] +--- + +# sailpoint.v2024.IdentitiesApi + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity +[**get-identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details +[**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details +[**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments +[**list-identities**](#list-identities) | **GET** `/identities` | List Identities +[**reset-identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity +[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email +[**start-identities-invite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register +[**start-identity-processing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds +[**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + + +## delete-identity +:::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. +::: +Delete identity +The API returns successful response if the requested identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity Id + | 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 is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. | IdentityAssociationDetails | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## get-identity +:::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. +::: +Identity Details +This API returns a single identity using the Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity Id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**Identity**](../models/identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity object | Identity | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity import Identity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-ownership-details +:::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. +::: +Get ownership details +Use this API to return an identity's owned objects that will cause problems for deleting the identity. +Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-ownership-details) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Identity's ownership association details. | IdentityOwnershipAssociationDetails | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assignment +:::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. +::: +Role assignment details + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity Id +Path | assignment_id | **str** | True | Assignment Id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A role assignment object | RoleAssignmentDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_assignment_dto import RoleAssignmentDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, assignment_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assignments +:::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. +::: +List role assignments +This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignments) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity Id to get the role assignments for + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | role_id | **str** | (optional) | Role Id to filter the role assignments with + Query | role_name | **str** | (optional) | Role name to filter the role assignments with + +### Return type +[**List[GetRoleAssignments200ResponseInner]**](../models/get-role-assignments200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A role assignment object | List[GetRoleAssignments200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-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. +::: +List Identities +This API returns a list of identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities) + +### 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 | 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* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *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, alias, cloudStatus** + Query | default_filter | **str** | (optional) (default to CORRELATED_ONLY) | 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. + 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 | 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[Identity]**](../models/identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identities. | List[Identity] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity import Identity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reset-identity +:::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. +::: +Reset an identity +Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | Identity Id + | 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 | +------------- | ------------- | ------------- |------------------| +202 | Accepted. The reset request accepted and is in progress. | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## send-identity-verification-account-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. +::: +Send password reset email +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-identity-verification-account-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. +Path | id | **str** | True | Identity ID + Body | send_account_verification_request | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The email was successfully sent | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.send_account_verification_request import SendAccountVerificationRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_send_account_verification_request.from_json(send_account_verification_request) + IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental, id, 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) +``` + + + +[[Back to top]](#) + +## start-identities-invite +:::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. +::: +Invite identities to register +This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identities-invite) + +### 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 | invite_identities_request | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True | + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Responds with an initial TaskStatus for the executed task | TaskStatus | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.invite_identities_request import InviteIdentitiesRequest +from sailpoint.v2024.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_invite_identities_request.from_json(invite_identities_request) + results =IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-identity-processing +:::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. +::: +Process a list of identityIds +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 endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identity-processing) + +### 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 | process_identities_request | [**ProcessIdentitiesRequest**](../models/process-identities-request) | True | + +### Return type +[**TaskResultResponse**](../models/task-result-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Object containing the DTO type TASK_RESULT and the job id for the task | TaskResultResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.process_identities_request import ProcessIdentitiesRequest +from sailpoint.v2024.models.task_result_response import TaskResultResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_process_identities_request.from_json(process_identities_request) + results =IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) +``` + + + +[[Back to top]](#) + +## synchronize-attributes-for-identity +:::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. +::: +Attribute synchronization for single identity. +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/synchronize-attributes-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | The Identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**IdentitySyncJob**](../models/identity-sync-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | An Identity Sync job | IdentitySyncJob | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identities_api import IdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_sync_job import IdentitySyncJob +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md new file mode 100644 index 000000000..139d34d41 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md @@ -0,0 +1,466 @@ +--- +id: v2024-identity-attributes +title: Identity_Attributes +pagination_label: Identity_Attributes +sidebar_label: Identity_Attributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_Attributes', 'V2024Identity_Attributes'] +slug: /tools/sdk/python/v2024/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'Identity_Attributes', 'V2024Identity_Attributes'] +--- + +# sailpoint.v2024.IdentityAttributesApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-attribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**get-identity-attribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute +[**list-identity-attributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes +[**put-identity-attribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute + + +## create-identity-attribute +:::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. +::: +Create Identity Attribute +Use this API to create a new identity attribute. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute) + +### 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 | identity_attribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The identity attribute was created successfully. | IdentityAttribute | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_identity_attribute.from_json(identity_attribute) + results =IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-attribute +:::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. +::: +Delete Identity Attribute +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The attribute's technical name. + | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## delete-identity-attributes-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. +::: +Bulk delete Identity Attributes +Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-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 | identity_attribute_names | [**IdentityAttributeNames**](../models/identity-attribute-names) | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNames +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_identity_attribute_names.from_json(identity_attribute_names) + IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, 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) +``` + + + +[[Back to top]](#) + +## get-identity-attribute +:::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. +::: +Get Identity Attribute +This gets an identity attribute for a given technical name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The attribute's technical name. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity attribute with the given name | IdentityAttribute | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-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. +::: +List Identity Attributes +Use this API to get a collection of identity attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-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. + Query | include_system | **bool** | (optional) (default to False) | Include 'system' attributes in the response. + Query | include_silent | **bool** | (optional) (default to False) | Include 'silent' attributes in the response. + Query | searchable_only | **bool** | (optional) (default to False) | Include only 'searchable' attributes in the response. + 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[IdentityAttribute]**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity attributes. | List[IdentityAttribute] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-identity-attribute +:::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. +::: +Update Identity Attribute +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The attribute's technical name. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | identity_attribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity attribute was updated successfully | IdentityAttribute | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_attribute import IdentityAttribute +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_identity_attribute.from_json(identity_attribute) + results =IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md new file mode 100644 index 000000000..2516ac0d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md @@ -0,0 +1,826 @@ +--- +id: v2024-identity-history +title: Identity_History +pagination_label: Identity_History +sidebar_label: Identity_History +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_History', 'V2024Identity_History'] +slug: /tools/sdk/python/v2024/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'Identity_History', 'V2024Identity_History'] +--- + +# sailpoint.v2024.IdentityHistoryApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**compare-identity-snapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**get-historical-identity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity +[**get-historical-identity-events**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity +[**get-identity-snapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**get-identity-start-date**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**list-historical-identities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities +[**list-identity-access-items**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type +[**list-identity-snapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + + +## compare-identity-snapshots +:::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. +::: +Gets a difference of count for each access item types for the given identity between 2 snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | snapshot1 | **str** | (optional) | The snapshot 1 of identity + Query | snapshot2 | **str** | (optional) | The snapshot 2 of identity + Query | access_item_types | **[]str** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + 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[IdentityCompareResponse]**](../models/identity-compare-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A IdentityCompare object with difference details for each access item type | List[IdentityCompareResponse] | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_compare_response import IdentityCompareResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + + 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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + +## compare-identity-snapshots-access-type +:::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. +::: +Gets a list of differences of specific accessType for the given identity between 2 snapshots +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots-access-type) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id +Path | access_type | **str** | True | The specific type which needs to be compared + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | access_associated | **bool** | (optional) | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + Query | snapshot1 | **str** | (optional) | The snapshot 1 of identity + Query | snapshot2 | **str** | (optional) | The snapshot 2 of identity + 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[AccessItemDiff]**](../models/access-item-diff) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of events for the identity | List[AccessItemDiff] | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.access_item_diff import AccessItemDiff +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, access_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-historical-identity +:::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. +::: +Get latest snapshot of identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity object. | IdentityHistoryResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-historical-identity-events +:::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. +::: +Lists all events for the given identity +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity-events) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | var_from | **str** | (optional) | The optional instant until which access events are returned + Query | event_types | **[]str** | (optional) | An optional list of event types to return. If null or empty, all events are returned + Query | access_item_types | **[]str** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + 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[GetHistoricalIdentityEvents200ResponseInner]**](../models/get-historical-identity-events200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of events for the identity | List[GetHistoricalIdentityEvents200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + + 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) + + 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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-snapshot +:::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. +::: +Gets an identity snapshot at a given date +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id +Path | var_date | **str** | True | The specified date + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity object. | IdentityHistoryResponse | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, var_date, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-snapshot-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. +::: +Gets the summary for the event count for a specific identity +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | before | **str** | (optional) | The date before which snapshot summary is required + Query | interval | **str** | (optional) | The interval indicating day or month. Defaults to month if not specified + Query | time_zone | **str** | (optional) | The time zone. Defaults to UTC if not provided + 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[MetricResponse]**](../models/metric-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A summary list of identity changes in date histogram format. | List[MetricResponse] | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.metric_response import MetricResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-start-date +:::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. +::: +Gets the start date of the identity +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-start-date) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The start date of the identity | 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-historical-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. +::: +Lists all the identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-historical-identities) + +### 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 | starts_with_query | **str** | (optional) | This param is used for starts-with search for first, last and display name of the identity + Query | is_deleted | **bool** | (optional) | Indicates if we want to only list down deleted identities or not. + Query | is_active | **bool** | (optional) | Indicates if we want to only list active or inactive identities. + 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[IdentityListItem]**](../models/identity-list-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identities for the customer. | List[IdentityListItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_list_item import IdentityListItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-access-items +:::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. +::: +List Access Items by Identity +This method retrieves a list of access item for the identity filtered by the access item type + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | type | **str** | (optional) | The type of access item for the identity. If not provided, it defaults to account + 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 | 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[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of access items. | List[ListIdentityAccessItems200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-snapshot-access-items +:::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. +::: +Gets the list of identity access items at a given date filterd by item type +This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshot-access-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id +Path | var_date | **str** | True | The specified date + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | type | **str** | (optional) | The access item type + +### Return type +[**List[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The identity object. | List[ListIdentityAccessItems200ResponseInner] | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, var_date, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-snapshots +:::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. +::: +Lists all the snapshots for the identity +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshots) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | start | **str** | (optional) | The specified start date + Query | interval | **str** | (optional) | The interval indicating the range in day or month for the specified interval-name + 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[IdentitySnapshotSummaryResponse]**](../models/identity-snapshot-summary-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of identity summary for each snapshot. | List[IdentitySnapshotSummaryResponse] | - | +400 | Client Error - 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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md new file mode 100644 index 000000000..6e32460b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md @@ -0,0 +1,883 @@ +--- +id: v2024-identity-profiles +title: Identity_Profiles +pagination_label: Identity_Profiles +sidebar_label: Identity_Profiles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_Profiles', 'V2024Identity_Profiles'] +slug: /tools/sdk/python/v2024/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'Identity_Profiles', 'V2024Identity_Profiles'] +--- + +# sailpoint.v2024.IdentityProfilesApi + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles +[**generate-identity-preview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**sync-identity-profile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Creates an identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_profile | [**IdentityProfile**](../models/identity-profile) | True | + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created identity profile. | IdentityProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_profile import IdentityProfile +from pprint import pprint +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() + new_identity_profile.from_json(identity_profile) + results =IdentityProfilesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_result_simplified import TaskResultSimplified +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | True | Identity Profile bulk delete request body. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_result_simplified import TaskResultSimplified +from pprint import pprint +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. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + + try: + # Delete Identity Profiles + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =IdentityProfilesApi(api_client).delete_identity_profiles(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-identity-profiles) + +### 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, ne* **name**: *eq, ne* **priority**: *eq, ne* + 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, priority** + +### Return type +[**List[IdentityProfileExportedObject]**](../models/identity-profile-exported-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of export objects with identity profiles. | List[IdentityProfileExportedObject] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_profile_exported_object import IdentityProfileExportedObject +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## generate-identity-preview +:::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. +::: +Generate Identity Profile Preview +This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/generate-identity-preview) + +### 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 | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. + +### Return type +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Object representing the preview object with all of the identity attributes using the current mappings. | IdentityPreviewResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_preview_request import IdentityPreviewRequest +from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_identity_preview_request.from_json(identity_preview_request) + results =IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-default-identity-attribute-config +Get default Identity Attribute Config +This returns the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-identity-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | The Identity Profile ID. + +### Return type +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An Identity Attribute Config object. | IdentityAttributeConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_attribute_config import IdentityAttributeConfig +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Identity profile object. | IdentityProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_profile import IdentityProfile +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-identity-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_profile_exported_object | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. + +### Return type +[**ObjectImportResult**](../models/object-import-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of importing Identity Profiles. | ObjectImportResult | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_profile_exported_object import IdentityProfileExportedObject +from sailpoint.v2024.models.object_import_result import ObjectImportResult +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.v2024.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject() + new_identity_profile_exported_object.from_json(identity_profile_exported_object) + results =IdentityProfilesApi(api_client).import_identity_profiles(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles) + +### 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + 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, priority, created, modified, owner.id, owner.name** + +### Return type +[**List[IdentityProfile]**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity profiles. | List[IdentityProfile] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_profile import IdentityProfile +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sync-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | The Identity Profile ID to be processed + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated identity profile. | IdentityProfile | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_profile import IdentityProfile +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from pprint import pprint +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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/Index.md b/docs/tools/sdk/python/Reference/V2024/Methods/Index.md new file mode 100644 index 000000000..a6552435f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['python', 'Python', 'sdk', 'methods'] +slug: /tools/sdk/python/v2024/methods +tags: ['SDK', 'Software Development Kit', 'v2024', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **V2024** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md new file mode 100644 index 000000000..ec9209b59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md @@ -0,0 +1,478 @@ +--- +id: v2024-lifecycle-states +title: Lifecycle_States +pagination_label: Lifecycle_States +sidebar_label: Lifecycle_States +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Lifecycle_States', 'V2024Lifecycle_States'] +slug: /tools/sdk/python/v2024/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'Lifecycle_States', 'V2024Lifecycle_States'] +--- + +# sailpoint.v2024.LifecycleStatesApi + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-lifecycle-state**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**delete-lifecycle-state**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**get-lifecycle-state**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**set-lifecycle-state**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## create-lifecycle-state +Create Lifecycle State +Use this endpoint to create a lifecycle state. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + Body | lifecycle_state | [**LifecycleState**](../models/lifecycle-state) | True | Lifecycle state to be created. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created LifecycleState object. | LifecycleState | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.lifecycle_state import LifecycleState +from pprint import pprint +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() + new_lifecycle_state.from_json(lifecycle_state) + results =LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-lifecycle-state +Delete Lifecycle State +Use this endpoint to delete the lifecycle state by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle state ID. + +### Return type +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The request was successfully accepted into the system. | LifecyclestateDeleted | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.lifecyclestate_deleted import LifecyclestateDeleted +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-lifecycle-state +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle state ID. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested LifecycleState was successfully retrieved. | LifecycleState | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.lifecycle_state import LifecycleState +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-lifecycle-states +Lists LifecycleStates +Use this endpoint to list all lifecycle states by their associated identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-states) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + 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 | 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: **created, modified** + +### Return type +[**List[LifecycleState]**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of LifecycleState objects. | List[LifecycleState] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.lifecycle_state import LifecycleState +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-lifecycle-state +Set Lifecycle State +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | ID of the identity to update. + Body | set_lifecycle_state_request | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | True | + +### Return type +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The request was successfully accepted into the system. | SetLifecycleState200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.set_lifecycle_state200_response import SetLifecycleState200Response +from sailpoint.v2024.models.set_lifecycle_state_request import SetLifecycleStateRequest +from pprint import pprint +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.v2024.SetLifecycleStateRequest() # SetLifecycleStateRequest | + + try: + # Set Lifecycle State + new_set_lifecycle_state_request = SetLifecycleStateRequest() + new_set_lifecycle_state_request.from_json(set_lifecycle_state_request) + results =LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-lifecycle-states) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle state ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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 + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The LifecycleState was successfully updated. | LifecycleState | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.lifecycle_state import LifecycleState +from pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md new file mode 100644 index 000000000..14c4a61f9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md @@ -0,0 +1,458 @@ +--- +id: v2024-mfa-configuration +title: MFA_Configuration +pagination_label: MFA_Configuration +sidebar_label: MFA_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MFA_Configuration', 'V2024MFA_Configuration'] +slug: /tools/sdk/python/v2024/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFA_Configuration', 'V2024MFA_Configuration'] +--- + +# sailpoint.v2024.MFAConfigurationApi + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-duo-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration of an Duo MFA method. | MfaDuoConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-kba-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | all_languages | **bool** | (optional) | 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 + +### Return type +[**List[KbaQuestion]**](../models/kba-question) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration for KBA MFA method. | List[KbaQuestion] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.kba_question import KbaQuestion +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-okta-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration of an Okta MFA method. | MfaOktaConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-duo-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | mfa_duo_config | [**MfaDuoConfig**](../models/mfa-duo-config) | True | + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an Duo MFA method. | MfaDuoConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig +from pprint import pprint +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() + new_mfa_duo_config.from_json(mfa_duo_config) + results =MFAConfigurationApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-okta-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | mfa_okta_config | [**MfaOktaConfig**](../models/mfa-okta-config) | True | + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an Okta MFA method. | MfaOktaConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig +from pprint import pprint +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() + new_mfa_okta_config.from_json(mfa_okta_config) + results =MFAConfigurationApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfakba-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | kba_answer_request_item | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**List[KbaAnswerResponseItem]**](../models/kba-answer-response-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The new KBA configuration for the user. | List[KbaAnswerResponseItem] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem +from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAConfigurationApi(api_client).set_mfakba_config(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-mfa-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md new file mode 100644 index 000000000..6f62cf194 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md @@ -0,0 +1,233 @@ +--- +id: v2024-machine-accounts +title: Machine_Accounts +pagination_label: Machine_Accounts +sidebar_label: Machine_Accounts +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Machine_Accounts', 'V2024Machine_Accounts'] +slug: /tools/sdk/python/v2024/methods/machine-accounts +tags: ['SDK', 'Software Development Kit', 'Machine_Accounts', 'V2024Machine_Accounts'] +--- + +# sailpoint.v2024.MachineAccountsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-machine-account**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details +[**list-machine-accounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List +[**update-machine-account**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account + + +## get-machine-account +:::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. +::: +Machine Account Details +Use this API to return the details for a single machine account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Machine Account ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**MachineAccount**](../models/machine-account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Machine Account object. | MachineAccount | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_account import MachineAccount +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-machine-accounts +:::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. +::: +Machine Accounts List +This returns a list of machine accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts) + +### 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: **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* + 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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** + +### Return type +[**List[MachineAccount]**](../models/machine-account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of machine account objects | List[MachineAccount] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_account import MachineAccount +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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* **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) # 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* **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) + 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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-machine-account +:::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. +::: +Update a Machine Account +Use this API to update machine accounts details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Machine Account ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | request_body | **[]object** | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**MachineAccount**](../models/machine-account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Machine Account object. | MachineAccount | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_account import MachineAccount +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + 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. + + + try: + # Update a Machine Account + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md new file mode 100644 index 000000000..bbe3188c5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md @@ -0,0 +1,371 @@ +--- +id: v2024-machine-identities +title: Machine_Identities +pagination_label: Machine_Identities +sidebar_label: Machine_Identities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Machine_Identities', 'V2024Machine_Identities'] +slug: /tools/sdk/python/v2024/methods/machine-identities +tags: ['SDK', 'Software Development Kit', 'Machine_Identities', 'V2024Machine_Identities'] +--- + +# sailpoint.v2024.MachineIdentitiesApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-identity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities +[**delete-machine-identity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity +[**get-machine-identity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details +[**list-machine-identities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities +[**update-machine-identity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity + + +## create-machine-identity +:::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. +::: +Create Machine Identities +Use this API to create a machine identity. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-identity) + +### 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 | machine_identity | [**MachineIdentity**](../models/machine-identity) | True | + +### Return type +[**MachineIdentity**](../models/machine-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Machine Identity created. | MachineIdentity | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_identity import MachineIdentity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_machine_identity.from_json(machine_identity) + results =MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-machine-identity +:::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. +::: +Delete machine identity +The API returns successful response if the requested machine identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Machine Identity ID + | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## get-machine-identity +:::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. +::: +Machine Identity Details +This API returns a single machine identity using the Machine Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Machine Identity ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**MachineIdentity**](../models/machine-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A machine identity object | MachineIdentity | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_identity import MachineIdentity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-machine-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. +::: +List Machine Identities +This API returns a list of machine identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities) + +### 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 | 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: **businessApplication, name** + 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 | 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[MachineIdentity]**](../models/machine-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of machine identities. | List[MachineIdentity] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_identity import MachineIdentity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 = '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, ) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset) + print("The response of MachineIdentitiesApi->list_machine_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-machine-identity +:::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. +::: +Update a Machine Identity +Use this API to update machine identity details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Machine Identity ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | request_body | **[]object** | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**MachineIdentity**](../models/machine-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Machine Identity object. | MachineIdentity | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.machine_identity import MachineIdentity +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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. + 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() + new_request_body.from_json(request_body) + results =MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md new file mode 100644 index 000000000..d3e601f9d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md @@ -0,0 +1,410 @@ +--- +id: v2024-managed-clients +title: Managed_Clients +pagination_label: Managed_Clients +sidebar_label: Managed_Clients +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Managed_Clients', 'V2024Managed_Clients'] +slug: /tools/sdk/python/v2024/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'Managed_Clients', 'V2024Managed_Clients'] +--- + +# sailpoint.v2024.ManagedClientsApi + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-client**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client +[**delete-managed-client**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client +[**get-managed-client**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client +[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status +[**get-managed-clients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients +[**update-managed-client**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client + + +## create-managed-client +Create Managed Client +Create a new managed client. +The API returns a result that includes the managed client ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | managed_client_request | [**ManagedClientRequest**](../models/managed-client-request) | True | + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created managed client. | ManagedClient | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_client import ManagedClient +from sailpoint.v2024.models.managed_client_request import ManagedClientRequest +from pprint import pprint +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() + new_managed_client_request.from_json(managed_client_request) + results =ManagedClientsApi(api_client).create_managed_client(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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-managed-client +Delete Managed Client +Delete an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-managed-client +Get Managed Client +Get managed client by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Managed client response. | ManagedClient | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_client import ManagedClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-client-status +Get Managed Client Status +Get a managed client's status, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID to get status for. + Query | type | [**ManagedClientType**](../models/managed-client-type) | True | Managed client type to get status for. + +### Return type +[**ManagedClientStatus**](../models/managed-client-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with the managed client status, with the given ID and type. | ManagedClientStatus | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_client_status import ManagedClientStatus +from sailpoint.v2024.models.managed_client_type import ManagedClientType +from pprint import pprint +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.v2024.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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-clients +Get Managed Clients +List managed clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clients) + +### 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: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* + +### Return type +[**List[ManagedClient]**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with a list of managed clients, based on the specified query parameters. | List[ManagedClient] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_client import ManagedClient +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-managed-client +Update Managed Client +Update an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated managed client. | ManagedClient | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.managed_client import ManagedClient +from pprint import pprint +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. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =ManagedClientsApi(api_client).update_managed_client(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md new file mode 100644 index 000000000..69c41be81 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md @@ -0,0 +1,478 @@ +--- +id: v2024-managed-clusters +title: Managed_Clusters +pagination_label: Managed_Clusters +sidebar_label: Managed_Clusters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Managed_Clusters', 'V2024Managed_Clusters'] +slug: /tools/sdk/python/v2024/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'Managed_Clusters', 'V2024Managed_Clusters'] +--- + +# sailpoint.v2024.ManagedClustersApi + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster +[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster + + +## create-managed-cluster +Create Create Managed Cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | managed_cluster_request | [**ManagedClusterRequest**](../models/managed-cluster-request) | True | + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created managed cluster. | ManagedCluster | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_cluster import ManagedCluster +from sailpoint.v2024.models.managed_cluster_request import ManagedClusterRequest +from pprint import pprint +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() + new_managed_cluster_request.from_json(managed_cluster_request) + results =ManagedClustersApi(api_client).create_managed_cluster(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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-managed-cluster +Delete Managed Cluster +Delete an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed cluster ID. + Query | remove_clients | **bool** | (optional) (default to False) | Flag to determine the need to delete a cluster with clients. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## get-client-log-configuration +Get Managed Cluster Log Configuration +Get a managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-client-log-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of managed cluster to get log configuration for. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Log configuration of managed cluster for given cluster ID. | ClientLogConfiguration | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-cluster +Get Managed Cluster +Get a managed cluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed cluster ID. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with managed cluster for the given ID. | ManagedCluster | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_cluster import ManagedCluster +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-clusters +Get Managed Clusters +List current organization's managed clusters, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clusters) + +### 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: **operational**: *eq* + +### Return type +[**List[ManagedCluster]**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with a list of managed clusters. | List[ManagedCluster] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.managed_cluster import ManagedCluster +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-client-log-configuration +Update Managed Cluster Log Configuration +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-client-log-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the managed cluster to update the log configuration for. + Body | put_client_log_configuration_request | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | True | Client log configuration for the given managed cluster. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with updated client log configuration for the given managed cluster. | ClientLogConfiguration | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration +from sailpoint.v2024.models.put_client_log_configuration_request import PutClientLogConfigurationRequest +from pprint import pprint +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.v2024.PutClientLogConfigurationRequest() # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest() + new_put_client_log_configuration_request.from_json(put_client_log_configuration_request) + results =ManagedClustersApi(api_client).put_client_log_configuration(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-managed-cluster +Update Managed Cluster +Update an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed cluster ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated managed cluster. | ManagedCluster | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.managed_cluster import ManagedCluster +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =ManagedClustersApi(api_client).update_managed_cluster(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md new file mode 100644 index 000000000..407dec97f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md @@ -0,0 +1,2185 @@ +--- +id: v2024-non-employee-lifecycle-management +title: Non_Employee_Lifecycle_Management +pagination_label: Non_Employee_Lifecycle_Management +sidebar_label: Non_Employee_Lifecycle_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Non_Employee_Lifecycle_Management', 'V2024Non_Employee_Lifecycle_Management'] +slug: /tools/sdk/python/v2024/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'Non_Employee_Lifecycle_Management', 'V2024Non_Employee_Lifecycle_Management'] +--- + +# sailpoint.v2024.NonEmployeeLifecycleManagementApi + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**export-non-employee-records**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**get-non-employee-approval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Body | non_employee_approval_decision | [**NonEmployeeApprovalDecision**](../models/non-employee-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 +import sailpoint.v2024 +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_decision import NonEmployeeApprovalDecision +from sailpoint.v2024.models.non_employee_approval_item import NonEmployeeApprovalItem +from pprint import pprint +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() + new_non_employee_approval_decision.from_json(non_employee_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request creation object | NonEmployeeRequest | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest +from sailpoint.v2024.models.non_employee_request_body import NonEmployeeRequestBody +from pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_source_request_body | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. + +### Return type +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_source_request_body import NonEmployeeSourceRequestBody +from sailpoint.v2024.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId +from pprint import pprint +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() + new_non_employee_source_request_body.from_json(non_employee_source_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create a new Schema Attribute for Non-Employee Source +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` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | non_employee_schema_attribute_body | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Schema Attribute created. | NonEmployeeSchemaAttribute | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from sailpoint.v2024.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody +from pprint import pprint +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() + new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee record id (UUID) + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-records-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-records-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | delete_non_employee_records_in_bulk_request | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | True | Non-Employee bulk delete request body. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + delete_non_employee_records_in_bulk_request = sailpoint.v2024.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + try: + # Delete Multiple Non-Employee Records + new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest() + new_delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee request id in the UUID format + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete a Schema Attribute for Non-Employee Source +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes for Non-Employee Source +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## export-non-employee-records +Exports Non-Employee Records to CSV +This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-non-employee-records) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported CSV | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## export-non-employee-source-schema-template +Exports Source Schema Template +This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-non-employee-source-schema-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported Source Schema Template | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-non-employee-approval +Get a non-employee approval item detail +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Query | include_detail | **bool** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + +### Return type +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail | - | +400 | Client Error - 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 +import sailpoint.v2024 +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_detail import NonEmployeeApprovalItemDetail +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-approval-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | requested_for | **str** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + +### Return type +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | summary of non-employee approval requests | NonEmployeeApprovalSummary | - | +400 | Client Error - 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 +import sailpoint.v2024 +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_summary import NonEmployeeApprovalSummary +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Obtain the status of bulk upload on the source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-bulk-upload-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID (UUID) + +### Return type +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee record id (UUID) + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee record object | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee request id (UUID) + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request object. | NonEmployeeRequest | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-request-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | requested_for | **str** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + +### Return type +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request summary object. | NonEmployeeRequestSummary | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_request_summary import NonEmployeeRequestSummary +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema Attribute | NonEmployeeSchemaAttribute | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_source import NonEmployeeSource +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**List[NonEmployeeSchemaAttribute]**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of Schema Attributes | List[NonEmployeeSchemaAttribute] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-non-employee-records-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + | data | **bytearray** | True | + +### Return type +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob | - | +400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-approvals +Get List of Non-Employee Approval Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | The identity for whom the request was made. *me* indicates the current user. + 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: **approvalStatus**: *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: **created, modified** + +### Return type +[**List[NonEmployeeApprovalItem]**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of approval items. | List[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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-records) + +### 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 | 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + 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: **sourceId**: *eq* + +### Return type +[**List[NonEmployeeRecord]**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee record objects | List[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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-requests) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | True | The identity for whom the request was made. *me* indicates the current user. + 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 | 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + 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: **sourceId**: *eq* + +### Return type +[**List[NonEmployeeRequest]**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of non-employee request objects. | List[NonEmployeeRequest] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-sources) + +### 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 | requested_for | **str** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | non_employee_count | **bool** | (optional) (default to False) | Flag that determines whether the API will return a non-employee count associated with the source. + 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, sourceId** + +### Return type +[**List[NonEmployeeSourceWithNECount]**](../models/non-employee-source-with-ne-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of non-employee sources objects. | List[NonEmployeeSourceWithNECount] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-employee record id (UUID) + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A patched 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +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_record import NonEmployeeRecord +from pprint import pprint +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) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch a Schema Attribute for Non-Employee Source +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + 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. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute | - | +400 | Client Error - 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 +import sailpoint.v2024 +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_schema_attribute import NonEmployeeSchemaAttribute +from pprint import pprint +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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (partial update)
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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, 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") + pprint(results) + 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..8489d8c8b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md @@ -0,0 +1,1050 @@ +--- +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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_domain_address.from_json(domain_address) + results =NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto import TemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_template_dto.from_json(template_dto) + results =NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_email_status_dto.from_json(email_status_dto) + results =NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + + try: + # Bulk Delete Notification Templates + new_template_bulk_delete_dto = TemplateBulkDeleteDto() + new_template_bulk_delete_dto.from_json(template_bulk_delete_dto) + NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dkim_attributes import DkimAttributes +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto import TemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.preferences_dto import PreferencesDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto import TemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_mail_from_attributes_dto.from_json(mail_from_attributes_dto) + results =NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_send_test_notification_request_dto.from_json(send_test_notification_request_dto) + NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, 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..941da4f59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md @@ -0,0 +1,352 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_create_o_auth_client_request.from_json(create_o_auth_client_request) + results =OAuthClientsApi(api_client).create_oauth_client(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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 + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =OAuthClientsApi(api_client).patch_oauth_client(id, 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") + pprint(results) + 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..a4af32f16 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md @@ -0,0 +1,229 @@ +--- +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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.org_config_api import OrgConfigApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, 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") + pprint(results) + 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..9e0aa6667 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md @@ -0,0 +1,219 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_org_config.from_json(password_org_config) + results =PasswordConfigurationApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_org_config.from_json(password_org_config) + results =PasswordConfigurationApi(api_client).put_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") + pprint(results) + 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..3181d028d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md @@ -0,0 +1,239 @@ +--- +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/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/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 +import sailpoint.v2024 +from sailpoint.v2024.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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..1358ed619 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md @@ -0,0 +1,330 @@ +--- +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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_password_digit_token_reset.from_json(password_digit_token_reset) + results =PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_info_query_dto.from_json(password_info_query_dto) + results =PasswordManagementApi(api_client).query_password_info(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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_change_request.from_json(password_change_request) + results =PasswordManagementApi(api_client).set_password(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") + pprint(results) + 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..0c3b3981b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md @@ -0,0 +1,403 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_policy_v3_dto.from_json(password_policy_v3_dto) + results =PasswordPoliciesApi(api_client).create_password_policy(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_policy_v3_dto.from_json(password_policy_v3_dto) + results =PasswordPoliciesApi(api_client).set_password_policy(id, 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") + pprint(results) + 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..f917c4871 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md @@ -0,0 +1,374 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_sync_group.from_json(password_sync_group) + results =PasswordSyncGroupsApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_password_sync_group.from_json(password_sync_group) + results =PasswordSyncGroupsApi(api_client).update_password_sync_group(id, 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") + pprint(results) + 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..ddc542eb3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md @@ -0,0 +1,290 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_create_personal_access_token_request.from_json(create_personal_access_token_request) + results =PersonalAccessTokensApi(api_client).create_personal_access_token(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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 + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =PersonalAccessTokensApi(api_client).patch_personal_access_token(id, 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") + pprint(results) + 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..0bf237ef8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md @@ -0,0 +1,94 @@ +--- +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/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/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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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..1ca498f00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md @@ -0,0 +1,162 @@ +--- +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/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/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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_public_identity_config.from_json(public_identity_config) + results =PublicIdentitiesConfigApi(api_client).update_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") + pprint(results) + 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..e6d8c2cef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md @@ -0,0 +1,277 @@ +--- +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 +import sailpoint.v2024 +from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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, ) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_report_details.from_json(report_details) + results =ReportsDataExtractionApi(api_client).start_report(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") + pprint(results) + 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..141b9ff24 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md @@ -0,0 +1,107 @@ +--- +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/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/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +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. + +[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. Support for additional types may be added in the future without notice. + Query | term | **str** | (optional) | 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. + 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. 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. + 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 +import sailpoint.v2024 +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 pprint import pprint +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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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) + 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") + pprint(results) + 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..7aa555866 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md @@ -0,0 +1,632 @@ +--- +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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, entitlement_id, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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..9b093c0df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -0,0 +1,1339 @@ +--- +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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from pprint import pprint +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() + new_role.from_json(role) + results =RolesApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_role_bulk_delete_request.from_json(role_bulk_delete_request) + results =RolesApi(api_client).delete_bulk_roles(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, attribute_key, 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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_identity import RoleIdentity +from pprint import pprint +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, ) + # 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") + pprint(results) + 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. +::: +List role's Entitlements +This API lists the Entitlements associated with a given 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 | ID of the containing role + | 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: **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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing 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') + 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* (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, 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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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 + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =RolesApi(api_client).patch_role(id, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from pprint import pprint +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, attribute_key, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_role_metadata_bulk_update_by_filter_request.from_json(role_metadata_bulk_update_by_filter_request) + results =RolesApi(api_client).update_roles_metadata_by_filter(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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_role_metadata_bulk_update_by_id_request.from_json(role_metadata_bulk_update_by_id_request) + results =RolesApi(api_client).update_roles_metadata_by_ids(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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_role_metadata_bulk_update_by_query_request.from_json(role_metadata_bulk_update_by_query_request) + results =RolesApi(api_client).update_roles_metadata_by_query(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") + pprint(results) + 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..4b0be8cfd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md @@ -0,0 +1,553 @@ +--- +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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_sim_integration_details.from_json(sim_integration_details) + results =SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_json_patch.from_json(json_patch) + results =SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_json_patch.from_json(json_patch) + results =SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_sim_integration_details.from_json(sim_integration_details) + results =SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, 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") + pprint(results) + 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..5be6bd293 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md @@ -0,0 +1,1299 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_sod_policy.from_json(sod_policy) + results =SODPoliciesApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, ) + # 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =SODPoliciesApi(api_client).patch_sod_policy(id, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_sod_policy_schedule.from_json(sod_policy_schedule) + results =SODPoliciesApi(api_client).put_policy_schedule(id, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_sod_policy.from_json(sod_policy) + results =SODPoliciesApi(api_client).put_sod_policy(id, 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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..a884bdb7e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md @@ -0,0 +1,176 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_identity_with_new_access.from_json(identity_with_new_access) + results =SODViolationsApi(api_client).start_predict_sod_violations(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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_identity_with_new_access1.from_json(identity_with_new_access1) + results =SODViolationsApi(api_client).start_violation_check(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") + pprint(results) + 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..b460bd6a4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md @@ -0,0 +1,474 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_export_payload.from_json(export_payload) + results =SPConfigApi(api_client).export_sp_config(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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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, ) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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..c99bdc081 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md @@ -0,0 +1,465 @@ +--- +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/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/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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_create_saved_search_request.from_json(create_saved_search_request) + results =SavedSearchApi(api_client).create_saved_search(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_search_arguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id, 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_saved_search.from_json(saved_search) + results =SavedSearchApi(api_client).put_saved_search(id, 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") + pprint(results) + 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..6dbd36fcb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md @@ -0,0 +1,517 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_create_scheduled_search_request.from_json(create_scheduled_search_request) + results =ScheduledSearchApi(api_client).create_scheduled_search(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_typed_reference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, 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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_scheduled_search.from_json(scheduled_search) + results =ScheduledSearchApi(api_client).update_scheduled_search(id, 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") + pprint(results) + 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..c77902dc1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md @@ -0,0 +1,648 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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() + new_search.from_json(search) + results =SearchApi(api_client).search_aggregate(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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search import Search +from pprint import pprint +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() + new_search.from_json(search) + SearchApi(api_client).search_count(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 +import sailpoint.v2024 +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search import Search +from pprint import pprint +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() + new_search.from_json(search) + results =SearchApi(api_client).search_post(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") + pprint(results) + 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..89be4d171 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md @@ -0,0 +1,381 @@ +--- +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/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/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. +::: +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 and attribute promotion configuration in the Link ObjectConfig. + +[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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_search_attribute_config.from_json(search_attribute_config) + results =SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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. + x_sail_point_experimental = 'true' # 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, 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. +::: +List Extended Search Attributes +Get a list of attribute/application associates 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. + +### Return type +[**List[SearchAttributeConfig]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of attribute configurations in ISC. | List[SearchAttributeConfig] | - | +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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 Extended Search Attributes + + results =SearchAttributeConfigurationApi(api_client).get_search_attribute_config(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) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + 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. +::: +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 +import sailpoint.v2024 +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 pprint import pprint +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. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, 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") + pprint(results) + 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..10ee55178 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md @@ -0,0 +1,374 @@ +--- +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 +import sailpoint.v2024 +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from pprint import pprint +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() + new_segment.from_json(segment) + results =SegmentsApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v2024 +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v2024 +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from pprint import pprint +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 + 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() + new_request_body.from_json(request_body) + results =SegmentsApi(api_client).patch_segment(id, 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") + pprint(results) + 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..8150a987d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md @@ -0,0 +1,730 @@ +--- +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 +import sailpoint.v2024 +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 pprint import pprint +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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto() + new_service_desk_integration_dto.from_json(service_desk_integration_dto) + results =ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of Service Desk integration to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Service Desk integration with the given ID successfully deleted | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to get + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto with the given ID | 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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + + try: + # Get a Service Desk integration + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the Service Desk integration template to get + +### Return type +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + + try: + # Service Desk integration template by scriptName + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-types) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[ServiceDeskIntegrationTemplateType]**](../models/service-desk-integration-template-type) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with an array of the currently supported Service Desk integration types. | List[ServiceDeskIntegrationTemplateType] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Service Desk integration types + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integrations +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integrations) + +### 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 | 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + 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[ServiceDeskIntegrationDto]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of ServiceDeskIntegrationDto | 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 +import sailpoint.v2024 +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 pprint import pprint +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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + + try: + # List existing Service Desk integrations + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integrations() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-status-check-details) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.queued_check_config_details import QueuedCheckConfigDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get the time check configuration + + results =ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to update + Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | 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. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto as updated | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v2024.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest() + new_patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + results =ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to update + Body | service_desk_integration_dto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto as updated | 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 +import sailpoint.v2024 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto() + new_service_desk_integration_dto.from_json(service_desk_integration_dto) + results =ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-status-check-details) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | queued_check_config_details | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.queued_check_config_details import QueuedCheckConfigDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails() + new_queued_check_config_details.from_json(queued_check_config_details) + results =ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md new file mode 100644 index 000000000..48fa8335a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md @@ -0,0 +1,152 @@ +--- +id: v2024-source-usages +title: Source_Usages +pagination_label: Source_Usages +sidebar_label: Source_Usages +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source_Usages', 'V2024Source_Usages'] +slug: /tools/sdk/python/v2024/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'Source_Usages', 'V2024Source_Usages'] +--- + +# sailpoint.v2024.SourceUsagesApi + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-status-by-source-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of IDN source + +### Return type +[**SourceUsageStatus**](../models/source-usage-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.source_usages_api import SourceUsagesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_usage_status import SourceUsageStatus +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-usages-by-source-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of IDN source + 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 | 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: **date** + +### Return type +[**List[SourceUsage]**](../models/source-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of source usage insights for past 12 months. | List[SourceUsage] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.source_usages_api import SourceUsagesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_usage import SourceUsage +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md new file mode 100644 index 000000000..d13a38f12 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md @@ -0,0 +1,3716 @@ +--- +id: v2024-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Sources', 'V2024Sources'] +slug: /tools/sdk/python/v2024/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'V2024Sources'] +--- + +# sailpoint.v2024.SourcesApi + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. +[**create-source-schedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create Schedule on Source +[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID +[**delete-source-schedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. +[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-accounts-schema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**get-correlation-config**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**get-entitlements-schema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**get-native-change-detection-config**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-health**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id +[**get-source-schedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type +[**get-source-schedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List Schedules on Source +[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation +[**import-accounts-schema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**import-connector-file**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-entitlements-schema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**peek-resource-objects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**ping-cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**sync-attributes-for-source**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. +[**test-source-configuration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**test-source-connection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**update-password-policy-holders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update Password Policy +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**update-source-schedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) +[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | provisioning_policy_dto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +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() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).create_provisioning_policy(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | source | [**Source**](../models/source) | True | + Query | provision_as_csv | **bool** | (optional) | 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. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | 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. | Source | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source import Source +from pprint import pprint +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() + new_source.from_json(source) + results =SourcesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source-schedule +Create Schedule on Source +Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Body | schedule1 | [**Schedule1**](../models/schedule1) | True | + +### Return type +[**Schedule1**](../models/schedule1) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The schedule was successfully created on the specified source. | Schedule1 | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.schedule1 import Schedule1 +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + schedule1 = sailpoint.v2024.Schedule1() # Schedule1 | + + try: + # Create Schedule on Source + new_schedule1 = Schedule1() + new_schedule1.from_json(schedule1) + results =SourcesApi(api_client).create_source_schedule(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Body | model_schema | [**ModelSchema**](../models/model-schema) | True | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The schema was successfully created on the specified source. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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.v2024.ModelSchema() # ModelSchema | + + try: + # Create Schema on Source + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).create_source_schema(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-accounts-async +:::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. +::: +Remove All Accounts in a Source +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-accounts-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted. Returns task result details of removal request. | 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_result_dto import TaskResultDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-native-change-detection-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. +::: +Delete Native Change Detection Configuration +Deletes the native change detection configuration for the source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-native-change-detection-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.usage_type import UsageType +from pprint import pprint +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.v2024.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, 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) +``` + + + +[[Back to top]](#) + +## delete-source +Delete Source by ID +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}` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**DeleteSource202Response**](../models/delete-source202-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | DeleteSource202Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.delete_source202_response import DeleteSource202Response +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-source-schedule +Delete Source Schedule by type. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schedule_type | **str** | True | The Schedule type. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## get-accounts-schema +Downloads source accounts schema template +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-accounts-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully downloaded the file | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-correlation-config +Get Source Correlation Configuration +This API returns the existing correlation configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-correlation-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Correlation configuration for a source | CorrelationConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.correlation_config import CorrelationConfig +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlements-schema +Downloads source entitlements schema template +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + Query | schema_name | **str** | (optional) | Name of entitlement schema + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully downloaded the file | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## get-native-change-detection-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. +::: +Native Change Detection Configuration +This API returns the existing native change detection configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-native-change-detection-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Native change detection configuration for a source | NativeChangeDetectionConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.native_change_detection_config import NativeChangeDetectionConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.v2024.models.usage_type import UsageType +from pprint import pprint +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.v2024.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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source object. | Source | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source import Source +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-attr-sync-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. +::: +Attribute Sync Config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-attr-sync-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Attribute synchronization configuration for a source | AttrSyncSourceConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-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. +::: +Gets source config with language translations +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Detail object | ConnectorDetail | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.connector_detail import ConnectorDetail +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + locale = 'locale_example' # 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, x_sail_point_experimental, ) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_config(id, x_sail_point_experimental, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-entitlement-request-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. +::: +Get Source Entitlement Request Configuration +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-entitlement-request-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 +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_entitlement_request_config import SourceEntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-health +Fetches source health by id +This endpoint fetches source health by source's id + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-health) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + +### Return type +[**SourceHealthDto**](../models/source-health-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Fetched source health successfully | SourceHealthDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_health_dto import SourceHealthDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schedule +Get Source Schedule by Type +Get the source schedule by type in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schedule_type | **str** | True | The Schedule type. + +### Return type +[**Schedule1**](../models/schedule1) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested Schedule was successfully retrieved. | Schedule1 | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.schedule1 import Schedule1 +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schedules +List Schedules on Source +Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schedules) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + +### Return type +[**List[Schedule1]**](../models/schedule1) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The schedules were successfully retrieved. | List[Schedule1] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.schedule1 import Schedule1 +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested Schema was successfully retrieved. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schemas) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Query | include_types | **str** | (optional) | 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. + Query | include_names | **str** | (optional) | A comma-separated list of schema names to filter result. + +### Return type +[**List[ModelSchema]**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The schemas were successfully retrieved. | List[ModelSchema] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-accounts +:::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. +::: +Account Aggregation +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-accounts) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + | file | **bytearray** | (optional) | The CSV file containing the source accounts to aggregate. + | disable_optimization | **str** | (optional) | Use this flag to reprocess every account whether or not the data has changed. + +### Return type +[**LoadAccountsTask**](../models/load-accounts-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Aggregate Accounts Task | LoadAccountsTask | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.load_accounts_task import LoadAccountsTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-accounts-schema +Uploads source accounts schema template +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-accounts-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + | file | **bytearray** | (optional) | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully uploaded the file | ModelSchema | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-connector-file) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + | file | **bytearray** | (optional) | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Uploaded the file successfully and sent all post-upload events | Source | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source import Source +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-entitlements-schema +Uploads source entitlements schema template +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + Query | schema_name | **str** | (optional) | Name of entitlement schema + | file | **bytearray** | (optional) | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully uploaded the file | ModelSchema | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-uncorrelated-accounts +:::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. +::: +Process Uncorrelated Accounts +File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-uncorrelated-accounts) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + | file | **bytearray** | (optional) | + +### Return type +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Uncorrelated Accounts Task | LoadUncorrelatedAccountsTask | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-provisioning-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**List[ProvisioningPolicyDto]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of ProvisioningPolicyDto objects | List[ProvisioningPolicyDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sources) + +### 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, 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* + 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: **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** + Query | for_subadmin | **str** | (optional) | 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. + Query | include_idn_source | **bool** | (optional) (default to False) | Include the IdentityNow source in the response. + +### Return type +[**List[Source]**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Source objects | List[Source] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source import Source +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## peek-resource-objects +:::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. +::: +Peek source connector's resource objects +Retrieves a sample of data returned from account and group aggregation requests. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/peek-resource-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | resource_objects_request | [**ResourceObjectsRequest**](../models/resource-objects-request) | True | + +### Return type +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest +from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + resource_objects_request = { + "maxCount" : 100, + "objectType" : "group" + } # ResourceObjectsRequest | + + try: + # Peek source connector's resource objects + new_resource_objects_request = ResourceObjectsRequest() + new_resource_objects_request.from_json(resource_objects_request) + results =SourcesApi(api_client).peek_resource_objects(source_id, x_sail_point_experimental, new_resource_objects_request) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).peek_resource_objects(source_id, x_sail_point_experimental, new_resource_objects_request) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + +## ping-cluster +:::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. +::: +Ping cluster for source connector +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/ping-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of pinging connection with the source connector. | StatusResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.status_response import StatusResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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: + # Ping cluster for source connector + + results =SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental) + print("The response of SourcesApi->ping_cluster:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-correlation-config +Update Source Correlation Configuration +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-correlation-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + Body | correlation_config | [**CorrelationConfig**](../models/correlation-config) | True | + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated correlation configuration for a source | CorrelationConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.correlation_config import CorrelationConfig +from pprint import pprint +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() + new_correlation_config.from_json(correlation_config) + results =SourcesApi(api_client).put_correlation_config(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-native-change-detection-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. +::: +Update Native Change Detection Configuration +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-native-change-detection-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | native_change_detection_config | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | True | + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated native change detection configuration for a source | NativeChangeDetectionConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.native_change_detection_config import NativeChangeDetectionConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_native_change_detection_config.from_json(native_change_detection_config) + results =SourcesApi(api_client).put_native_change_detection_config(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + Body | provisioning_policy_dto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.v2024.models.usage_type import UsageType +from pprint import pprint +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.v2024.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() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source +Update Source (Full) +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + Body | source | [**Source**](../models/source) | True | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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. | Source | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source import Source +from pprint import pprint +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() + new_source.from_json(source) + results =SourcesApi(api_client).put_source(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source-attr-sync-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. +::: +Update Attribute Sync Config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source-attr-sync-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | attr_sync_source_config | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | True | + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated attribute synchronization configuration for a source | AttrSyncSourceConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_attr_sync_source_config.from_json(attr_sync_source_config) + results =SourcesApi(api_client).put_source_attr_sync_config(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + Body | model_schema | [**ModelSchema**](../models/model-schema) | True | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema was successfully replaced. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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.v2024.ModelSchema() # ModelSchema | + + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).put_source_schema(source_id, schema_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sync-attributes-for-source +:::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. +::: +Synchronize single source attributes. +This end-point performs attribute synchronization for a selected source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sync-attributes-for-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**SourceSyncJob**](../models/source-sync-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | A Source Sync job | SourceSyncJob | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_sync_job import SourceSyncJob +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-source-configuration +:::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. +::: +Test configuration for source connector +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of testing source connector configuration with response from it. | StatusResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.status_response import StatusResponse +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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: + # Test configuration for source connector + + results =SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-source-connection +:::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. +::: +Check connection for source connector. +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-connection) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The ID of the Source. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of checking connection to the source connector with response from it. | StatusResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.status_response import StatusResponse +from pprint import pprint +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. + x_sail_point_experimental = 'true' # 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: + # Check connection for source connector. + + results =SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_connection:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-password-policy-holders +Update Password Policy +This API can be used to set up or update Password Policy in IdentityNow for the specified Source. +Source must support PASSWORD feature. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-policy-holders) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | password_policy_holders_dto_inner | [**[]PasswordPolicyHoldersDtoInner**](../models/password-policy-holders-dto-inner) | True | + +### Return type +[**List[PasswordPolicyHoldersDtoInner]**](../models/password-policy-holders-dto-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Password Policies | List[PasswordPolicyHoldersDtoInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_policy_holders_dto_inner import PasswordPolicyHoldersDtoInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + password_policy_holders_dto_inner = [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + + + try: + # Update Password Policy + new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner() + new_password_policy_holders_dto_inner.from_json(password_policy_holders_dto_inner) + results =SourcesApi(api_client).update_password_policy_holders(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policies-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + Body | provisioning_policy_dto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**List[ProvisioningPolicyDto]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of the ProvisioningPolicyDto was successfully replaced. | List[ProvisioningPolicyDto] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v2024.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.v2024.models.usage_type import UsageType +from pprint import pprint +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.v2024.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source +Update Source (Partial) +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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). + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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. | Source | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.source import Source +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-entitlement-request-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. +::: +Update Source Entitlement Request Configuration +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-entitlement-request-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 | source_entitlement_request_config | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | True | + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.source_entitlement_request_config import SourceEntitlementRequestConfig +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_source_entitlement_request_config.from_json(source_entitlement_request_config) + results =SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-schedule +Update Source Schedule (Partial) +Use this API to selectively update an existing Schedule using a JSONPatch payload. + +The following schedule fields are immutable and cannot be updated: + +- type + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schedule_type | **str** | True | The Schedule type. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schedule. + +### Return type +[**Schedule1**](../models/schedule1) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schedule was successfully updated. | Schedule1 | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.schedule1 import Schedule1 +from pprint import pprint +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. + [{op=replace, path=/cronExpression, value=0 0 6 * * ?}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + + + try: + # Update Source Schedule (Partial) + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schedule(source_id, schedule_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +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 +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema was successfully updated. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.model_schema import ModelSchema +from pprint import pprint +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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schema(source_id, schema_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md new file mode 100644 index 000000000..7bcc2eb54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md @@ -0,0 +1,511 @@ +--- +id: v2024-suggested-entitlement-description +title: Suggested_Entitlement_Description +pagination_label: Suggested_Entitlement_Description +sidebar_label: Suggested_Entitlement_Description +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Suggested_Entitlement_Description', 'V2024Suggested_Entitlement_Description'] +slug: /tools/sdk/python/v2024/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'Suggested_Entitlement_Description', 'V2024Suggested_Entitlement_Description'] +--- + +# sailpoint.v2024.SuggestedEntitlementDescriptionApi + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-sed-batch-stats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**get-sed-batches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**list-seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**patch-sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**submit-sed-approval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**submit-sed-assignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + + +## get-sed-batch-stats +Submit Sed Batch Stats Request +'Submit Sed Batch Stats Request. + + Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats + of the batchId.' + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batch-stats) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | batch_id | **str** | True | Batch Id + +### Return type +[**SedBatchStats**](../models/sed-batch-stats) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Stats of Sed batch. | SedBatchStats | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed_batch_stats import SedBatchStats +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sed-batches +List Sed Batch Request +List Sed Batches. +API responses with Sed Batch Status + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SedBatchStatus**](../models/sed-batch-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of batch | SedBatchStatus | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed_batch_status import SedBatchStatus +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-seds +List Suggested Entitlement Descriptions +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-seds) + +### 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *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: **displayName, sourceName, status** + Query | count_only | **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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + Query | requested_by_anyone | **bool** | (optional) (default to False) | 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 + Query | show_pending_status_only | **bool** | (optional) (default to False) | Will limit records to items that are in \"suggested\" or \"approved\" status + +### Return type +[**List[Sed]**](../models/sed) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Suggested Entitlement Details | List[Sed] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed import Sed +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sed +Patch Suggested Entitlement Description +Patch Suggested Entitlement Description + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | id is sed id + Body | sed_patch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request + +### Return type +[**Sed**](../models/sed) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | detail of patched sed | Sed | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed import Sed +from sailpoint.v2024.models.sed_patch import SedPatch +from pprint import pprint +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 + [sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + + try: + # Patch Suggested Entitlement Description + new_sed_patch = SedPatch() + new_sed_patch.from_json(sed_patch) + results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-sed-approval +Submit Bulk Approval Request +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sed_approval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval + +### Return type +[**List[SedApprovalStatus]**](../models/sed-approval-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of SED Approval Status | List[SedApprovalStatus] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed_approval import SedApproval +from sailpoint.v2024.models.sed_approval_status import SedApprovalStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + + try: + # Submit Bulk Approval Request + new_sed_approval = SedApproval() + new_sed_approval.from_json(sed_approval) + results =SuggestedEntitlementDescriptionApi(api_client).submit_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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-sed-assignment +Submit Sed Assignment Request +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-assignment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sed_assignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request + +### Return type +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Sed Assignment Response | SedAssignmentResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed_assignment import SedAssignment +from sailpoint.v2024.models.sed_assignment_response import SedAssignmentResponse +from pprint import pprint +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() + new_sed_assignment.from_json(sed_assignment) + results =SuggestedEntitlementDescriptionApi(api_client).submit_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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-sed-batch-request +Submit Sed Batch Request +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-batch-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sed_batch_request | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request + +### Return type +[**SedBatchResponse**](../models/sed-batch-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Sed Batch Response | SedBatchResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sed_batch_request import SedBatchRequest +from sailpoint.v2024.models.sed_batch_response import SedBatchResponse +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md new file mode 100644 index 000000000..7c199ea71 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md @@ -0,0 +1,617 @@ +--- +id: v2024-tagged-objects +title: Tagged_Objects +pagination_label: Tagged_Objects +sidebar_label: Tagged_Objects +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tagged_Objects', 'V2024Tagged_Objects'] +slug: /tools/sdk/python/v2024/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'Tagged_Objects', 'V2024Tagged_Objects'] +--- + +# sailpoint.v2024.TaggedObjectsApi + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of object to delete tags from. +Path | id | **str** | True | The ID of the object to delete tags from. + +### 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tags-to-many-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_remove_tagged_object | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.bulk_remove_tagged_object import BulkRemoveTaggedObject +from pprint import pprint +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() + new_bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_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) +``` + + + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to retrieve. +Path | id | **str** | True | The ID of the object reference to retrieve. + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tagged object by type and ID. | TaggedObject | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tagged_object import TaggedObject +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tagged-objects) + +### 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + +### Return type +[**List[TaggedObject]**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tagged objects. | List[TaggedObject] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tagged_object import TaggedObject +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tagged-objects-by-type) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to retrieve. + 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: **objectRef.id**: *eq* **objectRef.type**: *eq* + +### Return type +[**List[TaggedObject]**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tagged objects for specified type. | List[TaggedObject] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tagged_object import TaggedObject +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to update. +Path | id | **str** | True | The ID of the object reference to update. + Body | tagged_object | [**TaggedObject**](../models/tagged-object) | True | + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tagged object by type and ID. | TaggedObject | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tagged_object import TaggedObject +from pprint import pprint +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() + new_tagged_object.from_json(tagged_object) + results =TaggedObjectsApi(api_client).put_tagged_object(type, id, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tag-to-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | tagged_object | [**TaggedObject**](../models/tagged-object) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tagged_object import TaggedObject +from pprint import pprint +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() + new_tagged_object.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_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) +``` + + + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tags-to-many-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_add_tagged_object | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type +[**List[BulkTaggedObjectResponse]**](../models/bulk-tagged-object-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | List[BulkTaggedObjectResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.bulk_add_tagged_object import BulkAddTaggedObject +from sailpoint.v2024.models.bulk_tagged_object_response import BulkTaggedObjectResponse +from pprint import pprint +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() + new_bulk_add_tagged_object.from_json(bulk_add_tagged_object) + results =TaggedObjectsApi(api_client).set_tags_to_many_objects(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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md new file mode 100644 index 000000000..09308eb80 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md @@ -0,0 +1,375 @@ +--- +id: v2024-task-management +title: Task_Management +pagination_label: Task_Management +sidebar_label: Task_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Task_Management', 'V2024Task_Management'] +slug: /tools/sdk/python/v2024/methods/task-management +tags: ['SDK', 'Software Development Kit', 'Task_Management', 'V2024Task_Management'] +--- + +# sailpoint.v2024.TaskManagementApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-pending-task-headers**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**get-pending-tasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**get-task-status**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID +[**get-task-status-list**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List +[**update-task-status**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID + + +## get-pending-task-headers +:::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. +::: +Retrieve Pending Task List Headers +Responds with headers only for list of task statuses for pending tasks. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-task-headers) + +### 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. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Retrieve headers for a list of TaskStatus for pending tasks. | | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.task_management_api import TaskManagementApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## get-pending-tasks +:::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. +::: +Retrieve Pending Task Status List +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) + +### 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. + +### Return type +[**List[TaskStatus]**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a list of TaskStatus for pending tasks. | List[TaskStatus] | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.task_management_api import TaskManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-task-status +:::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. +::: +Get Task Status by ID +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Task ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus | - | +403 | Forbidden, generally due to a lack of security rights | | - | +404 | TaskStatus with the given id was not found. | | - | +400 | Client Error - 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.task_management_api import TaskManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-task-status-list +:::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. +::: +Retrieve Task Status List +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status-list) + +### 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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *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: **created** + +### Return type +[**List[TaskStatus]**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with a TaskStatus for the task with the given task ID. | List[TaskStatus] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.task_management_api import TaskManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-task-status +:::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. +::: +Update Task Status by ID +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-task-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Task ID. + | 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 | The JSONPatch payload used to update the object. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates the PATCH operation succeeded, and the API returns the updated task object. | TaskStatus | - | +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 | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v2024 +from sailpoint.v2024.api.task_management_api import TaskManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.task_status import TaskStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + + try: + # Update Task Status by ID + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =TaskManagementApi(api_client).update_task_status(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md new file mode 100644 index 000000000..b86b75611 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md @@ -0,0 +1,78 @@ +--- +id: v2024-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tenant', 'V2024Tenant'] +slug: /tools/sdk/python/v2024/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2024Tenant'] +--- + +# sailpoint.v2024.TenantApi + API for reading tenant details. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. + + +## get-tenant +Get Tenant Information. +This rest endpoint can be used to retrieve tenant details. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**Tenant**](../models/tenant) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tenant Info | Tenant | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.tenant_api import TenantApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tenant import Tenant +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md new file mode 100644 index 000000000..1f74f70b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md @@ -0,0 +1,350 @@ +--- +id: v2024-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Transforms', 'V2024Transforms'] +slug: /tools/sdk/python/v2024/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'V2024Transforms'] +--- + +# sailpoint.v2024.TransformsApi + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track +of which users have made changes to the Transforms. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **POST** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **GET** `/transforms` | List transforms +[**update-transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | transform | [**Transform**](../models/transform) | True | The transform to be created. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Indicates the transform was successfully created and returns its representation. | TransformRead | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.transforms_api import TransformsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.transform import Transform +from sailpoint.v2024.models.transform_read import TransformRead +from pprint import pprint +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() + new_transform.from_json(transform) + results =TransformsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-transform +Delete a transform +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform 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 +import sailpoint.v2024 +from sailpoint.v2024.api.transforms_api import TransformsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform to retrieve + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Transform with the given ID | TransformRead | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.transforms_api import TransformsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.transform_read import TransformRead +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-transforms) + +### 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 | name | **str** | (optional) | Name of the transform to retrieve from the list. + 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: **internal**: *eq* **name**: *eq, sw* + +### Return type +[**List[TransformRead]**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of transforms matching the given criteria. | List[TransformRead] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.transforms_api import TransformsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.transform_read import TransformRead +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-transform +Update a transform +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform to update + Body | transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.transforms_api import TransformsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.transform import Transform +from sailpoint.v2024.models.transform_read import TransformRead +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md new file mode 100644 index 000000000..2574c6c86 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md @@ -0,0 +1,837 @@ +--- +id: v2024-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Triggers', 'V2024Triggers'] +slug: /tools/sdk/python/v2024/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'V2024Triggers'] +--- + +# sailpoint.v2024.TriggersApi + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-trigger-invocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**create-subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription +[**delete-subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription +[**list-subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses +[**list-triggers**](#list-triggers) | **GET** `/triggers` | List Triggers +[**patch-subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation +[**test-subscription-filter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**update-subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription + + +## complete-trigger-invocation +:::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. +::: +Complete Trigger Invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-trigger-invocation) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the invocation to complete. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | complete_invocation | [**CompleteInvocation**](../models/complete-invocation) | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.complete_invocation import CompleteInvocation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_complete_invocation.from_json(complete_invocation) + TriggersApi(api_client).complete_trigger_invocation(id, x_sail_point_experimental, 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) +``` + + + +[[Back to top]](#) + +## create-subscription +:::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. +::: +Create a Subscription +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-subscription) + +### 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 | subscription_post_request | [**SubscriptionPostRequest**](../models/subscription-post-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. | Subscription | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.subscription import Subscription +from sailpoint.v2024.models.subscription_post_request import SubscriptionPostRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_subscription_post_request.from_json(subscription_post_request) + results =TriggersApi(api_client).create_subscription(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-subscription +:::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. +::: +Delete a Subscription +Deletes an existing subscription to a trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Subscription ID + | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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) +``` + + + +[[Back to top]](#) + +## list-subscriptions +:::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. +::: +List Subscriptions +Gets a list of all trigger subscriptions. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-subscriptions) + +### 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: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* + 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: **triggerId, triggerName** + +### Return type +[**List[Subscription]**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of subscriptions. | List[Subscription] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.subscription import Subscription +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-trigger-invocation-status +:::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. +::: +List Latest Invocation Statuses +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-trigger-invocation-status) + +### 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** + +### Return type +[**List[InvocationStatus]**](../models/invocation-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of latest invocation statuses. | List[InvocationStatus] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.invocation_status import InvocationStatus +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-triggers +:::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. +::: +List Triggers +Gets a list of triggers that are available in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-triggers) + +### 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: **id**: *eq, ge, le* + 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** + +### Return type +[**List[Trigger]**](../models/trigger) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of triggers. | List[Trigger] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.trigger import Trigger +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-subscription +:::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. +::: +Patch a Subscription +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** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Subscription to patch + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | subscription_patch_request_inner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated subscription. | Subscription | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.subscription import Subscription +from sailpoint.v2024.models.subscription_patch_request_inner import SubscriptionPatchRequestInner +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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') + [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + + try: + # Patch a Subscription + new_subscription_patch_request_inner = SubscriptionPatchRequestInner() + new_subscription_patch_request_inner.from_json(subscription_patch_request_inner) + results =TriggersApi(api_client).patch_subscription(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-test-trigger-invocation +:::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. +::: +Start a Test Invocation +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-test-trigger-invocation) + +### 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 | test_invocation | [**TestInvocation**](../models/test-invocation) | True | + +### Return type +[**List[Invocation]**](../models/invocation) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Test trigger invocations that have been started for specified subscription(s). | List[Invocation] | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.invocation import Invocation +from sailpoint.v2024.models.test_invocation import TestInvocation +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_test_invocation.from_json(test_invocation) + results =TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-subscription-filter +:::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. +::: +Validate a Subscription Filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-subscription-filter) + +### 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 | validate_filter_input_dto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True | + +### Return type +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Boolean whether specified filter expression is valid against the input. | ValidateFilterOutputDto | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.validate_filter_input_dto import ValidateFilterInputDto +from sailpoint.v2024.models.validate_filter_output_dto import ValidateFilterOutputDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_validate_filter_input_dto.from_json(validate_filter_input_dto) + results =TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-subscription +:::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. +::: +Update a Subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-subscription) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Subscription ID + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | subscription_put_request | [**SubscriptionPutRequest**](../models/subscription-put-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated subscription. | Subscription | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.triggers_api import TriggersApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.subscription import Subscription +from sailpoint.v2024.models.subscription_put_request import SubscriptionPutRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_subscription_put_request.from_json(subscription_put_request) + results =TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md new file mode 100644 index 000000000..4817c239f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md @@ -0,0 +1,158 @@ +--- +id: v2024-ui-metadata +title: UI_Metadata +pagination_label: UI_Metadata +sidebar_label: UI_Metadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UI_Metadata', 'V2024UI_Metadata'] +slug: /tools/sdk/python/v2024/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UI_Metadata', 'V2024UI_Metadata'] +--- + +# sailpoint.v2024.UIMetadataApi + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata + + +## get-tenant-ui-metadata +:::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. +::: +Get a tenant UI metadata +This API endpoint retrieves UI metadata configured for your tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-ui-metadata) + +### 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 +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A tenant UI metadata object | TenantUiMetadataItemResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.ui_metadata_api import UIMetadataApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-tenant-ui-metadata +:::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. +::: +Update tenant UI metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tenant-ui-metadata) + +### 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 | tenant_ui_metadata_item_update_request | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True | + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A tenant UI metadata object | TenantUiMetadataItemResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.ui_metadata_api import UIMetadataApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse +from sailpoint.v2024.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + results =UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md new file mode 100644 index 000000000..239ccfa78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md @@ -0,0 +1,254 @@ +--- +id: v2024-vendor-connector-mappings +title: Vendor_Connector_Mappings +pagination_label: Vendor_Connector_Mappings +sidebar_label: Vendor_Connector_Mappings +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Vendor_Connector_Mappings', 'V2024Vendor_Connector_Mappings'] +slug: /tools/sdk/python/v2024/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'Vendor_Connector_Mappings', 'V2024Vendor_Connector_Mappings'] +--- + +# sailpoint.v2024.VendorConnectorMappingsApi + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-vendor-connector-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | vendor_connector_mapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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() + new_vendor_connector_mapping.from_json(vendor_connector_mapping) + results =VendorConnectorMappingsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-vendor-connector-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | vendor_connector_mapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response +from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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() + new_vendor_connector_mapping.from_json(vendor_connector_mapping) + results =VendorConnectorMappingsApi(api_client).delete_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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-vendor-connector-mappings) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[VendorConnectorMapping]**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully retrieved list. | List[VendorConnectorMapping] | - | +400 | Client Error - 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md new file mode 100644 index 000000000..ce5490b3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md @@ -0,0 +1,853 @@ +--- +id: v2024-work-items +title: Work_Items +pagination_label: Work_Items +sidebar_label: Work_Items +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Work_Items', 'V2024Work_Items'] +slug: /tools/sdk/python/v2024/methods/work-items +tags: ['SDK', 'Software Development Kit', 'Work_Items', 'V2024Work_Items'] +--- + +# sailpoint.v2024.WorkItemsApi + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item +[**forward-work-item**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **GET** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + + +## approve-approval-item +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item +Path | approval_item_id | **str** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## approve-approval-items-in-bulk +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-items-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## complete-work-item +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A WorkItems object | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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: + # Complete a Work Item + + results =WorkItemsApi(api_client).complete_work_item(id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## forward-work-item +:::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. +::: +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Success, but no data is returned. | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_item_forward import WorkItemForward +from pprint import pprint +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 + x_sail_point_experimental = 'true' # 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() + new_work_item_forward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, 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) +``` + + + +[[Back to top]](#) + +## get-completed-work-items +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-completed-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + 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[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of completed work items. | List[WorkItems] | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-count-completed-work-items +:::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. +::: +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-completed-work-items) + +### 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 | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsCount | - | +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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items_count import WorkItemsCount +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-count-work-items +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsCount | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items_count import WorkItemsCount +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-work-item +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the work item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The work item with the given ID. | WorkItems | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-work-items-summary +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-items-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsSummary**](../models/work-items-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsSummary | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items_summary import WorkItemsSummary +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-work-items +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-work-items) + +### 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 | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**List[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | List[WorkItems] | - | +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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-approval-item +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item +Path | approval_item_id | **str** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-approval-items-in-bulk +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-items-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-account-selection +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-account-selection) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + Body | request_body | **map[string]object** | True | Account Selection Data map, keyed on fieldName + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_items_api import WorkItemsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.work_items import WorkItems +from pprint import pprint +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() + new_request_body.from_json(request_body) + results =WorkItemsApi(api_client).submit_account_selection(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md new file mode 100644 index 000000000..b4569eef6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md @@ -0,0 +1,644 @@ +--- +id: v2024-work-reassignment +title: Work_Reassignment +pagination_label: Work_Reassignment +sidebar_label: Work_Reassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Work_Reassignment', 'V2024Work_Reassignment'] +slug: /tools/sdk/python/v2024/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'Work_Reassignment', 'V2024Work_Reassignment'] +--- + +# sailpoint.v2024.WorkReassignmentApi + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-reassignment-configuration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations +[**put-reassignment-config**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + + +## create-reassignment-configuration +:::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. +::: +Create a Reassignment Configuration +Creates a new Reassignment Configuration for the specified identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-reassignment-configuration) + +### 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 | configuration_item_request | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The newly created Reassignment Configuration object | ConfigurationItemResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest +from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_configuration_item_request.from_json(configuration_item_request) + results =WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-reassignment-configuration +:::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. +::: +Delete Reassignment Configuration +Deletes a single reassignment configuration for the specified identity + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id +Path | config_type | [**ConfigTypeEnum**](../models/config-type-enum) | 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 | Reassignment Configuration deleted | | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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, config_type, 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) +``` + + + +[[Back to top]](#) + +## get-evaluate-reassignment-configuration +:::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. +::: +Evaluate Reassignment Configuration +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-evaluate-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id +Path | config_type | [**ConfigTypeEnum**](../models/config-type-enum) | True | Reassignment work type + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | exclusion_filters | **[]str** | (optional) | 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 + +### Return type +[**List[EvaluateResponse]**](../models/evaluate-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Evaluated Reassignment Configuration | List[EvaluateResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum +from sailpoint.v2024.models.evaluate_response import EvaluateResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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) + + 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, config_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-reassignment-config-types +:::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. +::: +List Reassignment Config Types +Gets a collection of types which are available in the Reassignment Configuration UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-config-types) + +### 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[ConfigType]**](../models/config-type) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Reassignment Configuration Types | List[ConfigType] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.config_type import ConfigType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-reassignment-configuration +:::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. +::: +Get Reassignment Configuration +Gets the Reassignment Configuration for an identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**ConfigurationResponse**](../models/configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reassignment Configuration for an identity | ConfigurationResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.configuration_response import ConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-tenant-config-configuration +:::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. +::: +Get Tenant-wide Reassignment Configuration settings +Gets the global Reassignment Configuration settings for the requestor's tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-config-configuration) + +### 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 +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-reassignment-configurations +:::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. +::: +List Reassignment Configurations +Gets all Reassignment configuration for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-reassignment-configurations) + +### 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[ConfigurationResponse]**](../models/configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of Reassignment Configurations for an org | List[ConfigurationResponse] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.configuration_response import ConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-reassignment-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. +::: +Update Reassignment Configuration +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-reassignment-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | unique identity id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | configuration_item_request | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reassignment Configuration updated | ConfigurationItemResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest +from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_configuration_item_request.from_json(configuration_item_request) + results =WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-tenant-configuration +:::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. +::: +Update Tenant-wide Reassignment Configuration settings +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tenant-configuration) + +### 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 | tenant_configuration_request | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | True | + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.tenant_configuration_request import TenantConfigurationRequest +from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +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() + new_tenant_configuration_request.from_json(tenant_configuration_request) + results =WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md new file mode 100644 index 000000000..b521a1958 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md @@ -0,0 +1,1185 @@ +--- +id: v2024-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Workflows', 'V2024Workflows'] +slug: /tools/sdk/python/v2024/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'V2024Workflows'] +--- + +# sailpoint.v2024.WorkflowsApi + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-external-execute-workflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **GET** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow +[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-workflow-execution) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The workflow execution ID + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## create-external-execute-workflow +Execute Workflow via External Trigger +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-external-execute-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | create_external_execute_workflow_request | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | (optional) | + +### Return type +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | CreateExternalExecuteWorkflow200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response +from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest +from pprint import pprint +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.v2024.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + + try: + # Execute Workflow via External Trigger + + results =WorkflowsApi(api_client).create_external_execute_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_workflow_request | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest +from sailpoint.v2024.models.workflow import Workflow +from pprint import pprint +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() + new_create_workflow_request.from_json(create_workflow_request) + results =WorkflowsApi(api_client).create_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-workflow-external-trigger +Generate External Trigger OAuth Client +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow-external-trigger) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + +### Return type +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The OAuth Client object | WorkflowOAuthClient | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + +### 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow import Workflow +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Workflow execution ID. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Workflow execution. | 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution-history) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow execution + +### Return type +[**List[WorkflowExecutionEvent]**](../models/workflow-execution-event) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow execution events for the given workflow execution | List[WorkflowExecutionEvent] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-executions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Workflow ID. + 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + +### Return type +[**List[WorkflowExecution]**](../models/workflow-execution) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow executions for the specified workflow. | List[WorkflowExecution] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow_execution import WorkflowExecution +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-complete-workflow-library) + +### 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[ListCompleteWorkflowLibrary200ResponseInner]**](../models/list-complete-workflow-library200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow steps | List[ListCompleteWorkflowLibrary200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-actions) + +### 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 | 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* + +### Return type +[**List[WorkflowLibraryAction]**](../models/workflow-library-action) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow actions | List[WorkflowLibraryAction] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-operators) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[WorkflowLibraryOperator]**](../models/workflow-library-operator) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow operators | List[WorkflowLibraryOperator] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-triggers) + +### 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 | 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* + +### Return type +[**List[WorkflowLibraryTrigger]**](../models/workflow-library-trigger) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow triggers | List[WorkflowLibraryTrigger] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflows) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[Workflow]**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflows | List[Workflow] | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow import Workflow +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.workflow import Workflow +from pprint import pprint +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 + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =WorkflowsApi(api_client).patch_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.workflow import Workflow +from sailpoint.v2024.models.workflow_body import WorkflowBody +from pprint import pprint +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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + + try: + # Update Workflow + new_workflow_body = WorkflowBody() + new_workflow_body.from_json(workflow_body) + results =WorkflowsApi(api_client).put_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-external-execute-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | test_external_execute_workflow_request | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | + +### Return type +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the test input | TestExternalExecuteWorkflow200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response +from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest +from pprint import pprint +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.v2024.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + + try: + # Test Workflow via External Trigger + + results =WorkflowsApi(api_client).test_external_execute_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | test_workflow_request | [**TestWorkflowRequest**](../models/test-workflow-request) | True | + +### Return type +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | TestWorkflow200Response | - | +400 | Client Error - 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 +import sailpoint.v2024 +from sailpoint.v2024.api.workflows_api import WorkflowsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response +from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest +from pprint import pprint +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() + new_test_workflow_request.from_json(test_workflow_request) + results =WorkflowsApi(api_client).test_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Access.md b/docs/tools/sdk/python/Reference/V2024/Models/Access.md new file mode 100644 index 000000000..c3be3b9c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Access.md @@ -0,0 +1,39 @@ +--- +id: v2024-access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access', 'V2024Access'] +slug: /tools/sdk/python/v2024/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'V2024Access'] +--- + +# Access + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.access import Access + +access = Access( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessApps.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessApps.md new file mode 100644 index 000000000..2cbbc3670 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessApps.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-apps +title: AccessApps +pagination_label: AccessApps +sidebar_label: AccessApps +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessApps', 'V2024AccessApps'] +slug: /tools/sdk/python/v2024/models/access-apps +tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2024AccessApps'] +--- + +# AccessApps + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | Name of application | [optional] +**description** | **str** | Description of application. | [optional] +**owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_apps import AccessApps + +access_apps = AccessApps( +id='2c91808568c529c60168cca6f90c1313', +name='Travel and Expense', +description='Travel and Expense Application', +owner=sailpoint.v2024.models.access_apps_owner.AccessApps_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'John Doe', + email = 'john.doe@sailpoint.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessAppsOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessAppsOwner.md new file mode 100644 index 000000000..7a8df8449 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessAppsOwner.md @@ -0,0 +1,40 @@ +--- +id: v2024-access-apps-owner +title: AccessAppsOwner +pagination_label: AccessAppsOwner +sidebar_label: AccessAppsOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessAppsOwner', 'V2024AccessAppsOwner'] +slug: /tools/sdk/python/v2024/models/access-apps-owner +tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2024AccessAppsOwner'] +--- + +# AccessAppsOwner + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's display name. | [optional] +**email** | **str** | Owner's email. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_apps_owner import AccessAppsOwner + +access_apps_owner = AccessAppsOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='John Doe', +email='john.doe@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessConstraint.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessConstraint.md new file mode 100644 index 000000000..c9b178306 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessConstraint.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessConstraint', 'V2024AccessConstraint'] +slug: /tools/sdk/python/v2024/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'V2024AccessConstraint'] +--- + +# AccessConstraint + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Type of Access | [required] +**ids** | **[]str** | Must be set only if operator is SELECTED. | [optional] +**operator** | **Enum** [ 'ALL', 'SELECTED' ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_constraint import AccessConstraint + +access_constraint = AccessConstraint( +type='ENTITLEMENT', +ids=[2c90ad2a70ace7d50170acf22ca90010], +operator='SELECTED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessCriteria.md new file mode 100644 index 000000000..3ac13f244 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessCriteria.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteria', 'V2024AccessCriteria'] +slug: /tools/sdk/python/v2024/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'V2024AccessCriteria'] +--- + +# AccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Business name for the access construct list | [optional] +**criteria_list** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_criteria import AccessCriteria + +access_criteria = AccessCriteria( +name='money-in', +criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..7cbd3d207 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteriaCriteriaListInner', 'V2024AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/python/v2024/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'V2024AccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Type of the propery to which this reference applies to | [optional] +**id** | **str** | ID of the object to which this reference applies to | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_criteria_criteria_list_inner import AccessCriteriaCriteriaListInner + +access_criteria_criteria_list_inner = AccessCriteriaCriteriaListInner( +type='ENTITLEMENT', +id='2c91808568c529c60168cca6f90c1313', +name='Administrator' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..0776c3c3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,55 @@ +--- +id: v2024-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAccessProfileResponse', 'V2024AccessItemAccessProfileResponse'] +slug: /tools/sdk/python/v2024/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2024AccessItemAccessProfileResponse'] +--- + +# AccessItemAccessProfileResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. accessProfile in this case | [optional] +**id** | **str** | the access item id | [optional] +**name** | **str** | the access profile name | [optional] +**source_name** | **str** | the name of the source | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the access profile | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional] +**app_display_name** | **str** | the name of | [optional] +**remove_date** | **str** | the date the access profile is no longer assigned to the specified identity | [optional] +**standalone** | **bool** | indicates whether the access profile is standalone | [required] +**revocable** | **bool** | indicates whether the access profile is | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_access_profile_response import AccessItemAccessProfileResponse + +access_item_access_profile_response = AccessItemAccessProfileResponse( +access_type='accessProfile', +id='2c918087763e69d901763e72e97f006f', +name='sample', +source_name='DataScienceDataset', +source_id='2793o32dwd', +description='AccessProfile - Workday/Citizenship access', +display_name='Dr. Arden Rogahn MD', +entitlement_count='12', +app_display_name='AppName', +remove_date='2024-07-01T06:00:00.00Z', +standalone=False, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccountResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..f04e9d1eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccountResponse.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAccountResponse', 'V2024AccessItemAccountResponse'] +slug: /tools/sdk/python/v2024/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2024AccessItemAccountResponse'] +--- + +# AccessItemAccountResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. account in this case | [optional] +**id** | **str** | the access item id | [optional] +**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] +**source_name** | **str** | the name of the source | [optional] +**source_id** | **str** | the id of the source | [optional] +**entitlement_count** | **str** | the number of entitlements the account will create | [optional] +**display_name** | **str** | the display name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_account_response import AccessItemAccountResponse + +access_item_account_response = AccessItemAccountResponse( +access_type='account', +id='2c918087763e69d901763e72e97f006f', +native_identity='dr.arden.ogahn.d', +source_name='DataScienceDataset', +source_id='2793o32dwd', +entitlement_count='12', +display_name='Dr. Arden Rogahn MD' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAppResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..02a6036bf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAppResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAppResponse', 'V2024AccessItemAppResponse'] +slug: /tools/sdk/python/v2024/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2024AccessItemAppResponse'] +--- + +# AccessItemAppResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. entitlement in this case | [optional] +**id** | **str** | the access item id | [optional] +**display_name** | **str** | the access item display name | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**app_role_id** | **str** | the app role id | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_app_response import AccessItemAppResponse + +access_item_app_response = AccessItemAppResponse( +access_type='app', +id='2c918087763e69d901763e72e97f006f', +display_name='Display Name', +source_name='appName', +app_role_id='2c918087763e69d901763e72e97f006f' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemApproverDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..db87156f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemApproverDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemApproverDto', 'V2024AccessItemApproverDto'] +slug: /tools/sdk/python/v2024/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'V2024AccessItemApproverDto'] +--- + +# AccessItemApproverDto + +Identity who approved the access item request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who approved the access item request. | [optional] +**id** | **str** | ID of identity who approved the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who approved the access item request. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_approver_dto import AccessItemApproverDto + +access_item_approver_dto = AccessItemApproverDto( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociated.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociated.md new file mode 100644 index 000000000..b58e9c62c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociated.md @@ -0,0 +1,50 @@ +--- +id: v2024-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAssociated', 'V2024AccessItemAssociated'] +slug: /tools/sdk/python/v2024/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2024AccessItemAssociated'] +--- + +# AccessItemAssociated + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_associated import AccessItemAssociated + +access_item_associated = AccessItemAssociated( +access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name}, +identity_id='8c190e6787aa4ed9a90bd9d5344523fb', +event_type='AccessItemAssociated', +dt='2019-03-08T22:37:33.901Z', +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', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..be7641c4d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,69 @@ +--- +id: v2024-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemAssociatedAccessItem', 'V2024AccessItemAssociatedAccessItem'] +slug: /tools/sdk/python/v2024/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V2024AccessItemAssociatedAccessItem'] +--- + +# AccessItemAssociatedAccessItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. role in this case | [optional] +**id** | **str** | the access item id | [optional] +**name** | **str** | the access profile name | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the role | [optional] +**display_name** | **str** | the role display name | [optional] +**entitlement_count** | **str** | the number of entitlements the account will create | [optional] +**app_display_name** | **str** | the name of | [optional] +**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional] +**standalone** | **bool** | indicates whether the entitlement is standalone | [required] +**revocable** | **bool** | indicates whether the role is revocable | [required] +**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] +**app_role_id** | **str** | the app role id | [optional] +**attribute** | **str** | the entitlement attribute | [optional] +**value** | **str** | the associated value | [optional] +**entitlement_type** | **str** | the type of entitlement | [optional] +**privileged** | **bool** | indicates whether the entitlement is privileged | [required] +**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_associated_access_item import AccessItemAssociatedAccessItem + +access_item_associated_access_item = AccessItemAssociatedAccessItem( +access_type='role', +id='2c918087763e69d901763e72e97f006f', +name='sample', +source_name='Source Name', +source_id='2793o32dwd', +description='Role - Workday/Citizenship access', +display_name='sample', +entitlement_count='12', +app_display_name='AppName', +remove_date='2024-07-01T06:00:00.00Z', +standalone=True, +revocable=True, +native_identity='dr.arden.ogahn.d', +app_role_id='2c918087763e69d901763e72e97f006f', +attribute='groups', +value='Upward mobility access', +entitlement_type='entitlement', +privileged=False, +cloud_governed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemDiff.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemDiff.md new file mode 100644 index 000000000..95f73730c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemDiff.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemDiff', 'V2024AccessItemDiff'] +slug: /tools/sdk/python/v2024/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'V2024AccessItemDiff'] +--- + +# AccessItemDiff + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of the access item | [optional] +**event_type** | **Enum** [ 'ADD', 'REMOVE' ] | | [optional] +**display_name** | **str** | the display name of the access item | [optional] +**source_name** | **str** | the source name of the access item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_diff import AccessItemDiff + +access_item_diff = AccessItemDiff( +id='', +event_type='ADD', +display_name='', +source_name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..3af9da6be --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,55 @@ +--- +id: v2024-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemEntitlementResponse', 'V2024AccessItemEntitlementResponse'] +slug: /tools/sdk/python/v2024/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V2024AccessItemEntitlementResponse'] +--- + +# AccessItemEntitlementResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. entitlement in this case | [optional] +**id** | **str** | the access item id | [optional] +**attribute** | **str** | the entitlement attribute | [optional] +**value** | **str** | the associated value | [optional] +**entitlement_type** | **str** | the type of entitlement | [optional] +**source_name** | **str** | the name of the source | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the entitlment | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**standalone** | **bool** | indicates whether the entitlement is standalone | [required] +**privileged** | **bool** | indicates whether the entitlement is privileged | [required] +**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_entitlement_response import AccessItemEntitlementResponse + +access_item_entitlement_response = AccessItemEntitlementResponse( +access_type='entitlement', +id='2c918087763e69d901763e72e97f006f', +attribute='groups', +value='Upward mobility access', +entitlement_type='entitlement', +source_name='DataScienceDataset', +source_id='2793o32dwd', +description='Entitlement - Workday/Citizenship access', +display_name='Dr. Arden Rogahn MD', +standalone=True, +privileged=False, +cloud_governed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRef.md new file mode 100644 index 000000000..b12243afb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRef.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRef', 'V2024AccessItemRef'] +slug: /tools/sdk/python/v2024/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'V2024AccessItemRef'] +--- + +# AccessItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the access item to retrieve the recommendation for. | [optional] +**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Access item's type. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_ref import AccessItemRef + +access_item_ref = AccessItemRef( +id='2c938083633d259901633d2623ec0375', +type='ENTITLEMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRemoved.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRemoved.md new file mode 100644 index 000000000..ad170b733 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRemoved.md @@ -0,0 +1,50 @@ +--- +id: v2024-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRemoved', 'V2024AccessItemRemoved'] +slug: /tools/sdk/python/v2024/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2024AccessItemRemoved'] +--- + +# AccessItemRemoved + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_removed import AccessItemRemoved + +access_item_removed = AccessItemRemoved( +access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name}, +identity_id='8c190e6787aa4ed9a90bd9d5344523fb', +event_type='AccessItemRemoved', +dt='2019-03-08T22:37:33.901Z', +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', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequestedFor.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..efab76d2a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequestedFor.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedFor', 'V2024AccessItemRequestedFor'] +slug: /tools/sdk/python/v2024/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'V2024AccessItemRequestedFor'] +--- + +# AccessItemRequestedFor + +Identity the access item is requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity the access item is requested for. | [optional] +**id** | **str** | ID of identity the access item is requested for. | [optional] +**name** | **str** | Human-readable display name of identity the access item is requested for. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_requested_for import AccessItemRequestedFor + +access_item_requested_for = AccessItemRequestedFor( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..08366166d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequestedForDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedForDto', 'V2024AccessItemRequestedForDto'] +slug: /tools/sdk/python/v2024/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'V2024AccessItemRequestedForDto'] +--- + +# AccessItemRequestedForDto + +Identity the access item is requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity the access item is requested for. | [optional] +**id** | **str** | ID of identity the access item is requested for. | [optional] +**name** | **str** | Human-readable display name of identity the access item is requested for. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_requested_for_dto import AccessItemRequestedForDto + +access_item_requested_for_dto = AccessItemRequestedForDto( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequester.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequester.md new file mode 100644 index 000000000..474ac664b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequester.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequester', 'V2024AccessItemRequester'] +slug: /tools/sdk/python/v2024/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'V2024AccessItemRequester'] +--- + +# AccessItemRequester + +Access item requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional] +**id** | **str** | Access item requester's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_requester import AccessItemRequester + +access_item_requester = AccessItemRequester( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequesterDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..4b9a811b3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRequesterDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequesterDto', 'V2024AccessItemRequesterDto'] +slug: /tools/sdk/python/v2024/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'V2024AccessItemRequesterDto'] +--- + +# AccessItemRequesterDto + +Access item requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional] +**id** | **str** | Access item requester's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_requester_dto import AccessItemRequesterDto + +access_item_requester_dto = AccessItemRequesterDto( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemReviewedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..81797d5d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemReviewedBy.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemReviewedBy', 'V2024AccessItemReviewedBy'] +slug: /tools/sdk/python/v2024/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'V2024AccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +Identity who reviewed the access item request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_reviewed_by import AccessItemReviewedBy + +access_item_reviewed_by = AccessItemReviewedBy( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRoleResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..ce3cd36cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessItemRoleResponse.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRoleResponse', 'V2024AccessItemRoleResponse'] +slug: /tools/sdk/python/v2024/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2024AccessItemRoleResponse'] +--- + +# AccessItemRoleResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. role in this case | [optional] +**id** | **str** | the access item id | [optional] +**display_name** | **str** | the role display name | [optional] +**description** | **str** | the description for the role | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional] +**revocable** | **bool** | indicates whether the role is revocable | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_item_role_response import AccessItemRoleResponse + +access_item_role_response = AccessItemRoleResponse( +access_type='role', +id='2c918087763e69d901763e72e97f006f', +display_name='sample', +description='Role - Workday/Citizenship access', +source_name='Source Name', +remove_date='2024-07-01T06:00:00.00Z', +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadata.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadata.md new file mode 100644 index 000000000..3bed9b396 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadata.md @@ -0,0 +1,55 @@ +--- +id: v2024-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +slug: /tools/sdk/python/v2024/models/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +--- + +# AccessModelMetadata + +Metadata that describes an access item + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Unique identifier for the metadata type | [optional] +**name** | **str** | Human readable name of the metadata type | [optional] +**multiselect** | **bool** | Allows selecting multiple values | [optional] [default to False] +**status** | **str** | The state of the metadata item | [optional] +**type** | **str** | The type of the metadata item | [optional] +**object_types** | **[]str** | The types of objects | [optional] +**description** | **str** | Describes the metadata item | [optional] +**values** | [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_model_metadata import AccessModelMetadata + +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/AccessModelMetadataValuesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadataValuesInner.md new file mode 100644 index 000000000..3a3fb81c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadataValuesInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-model-metadata-values-inner +title: AccessModelMetadataValuesInner +pagination_label: AccessModelMetadataValuesInner +sidebar_label: AccessModelMetadataValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner'] +slug: /tools/sdk/python/v2024/models/access-model-metadata-values-inner +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner'] +--- + +# AccessModelMetadataValuesInner + +An individual value to assign to the metadata item + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The value to assign to the metdata item | [optional] +**name** | **str** | Display name of the value | [optional] +**status** | **str** | The status of the individual value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_model_metadata_values_inner import AccessModelMetadataValuesInner + +access_model_metadata_values_inner = AccessModelMetadataValuesInner( +value='development', +name='Development', +status='active' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md new file mode 100644 index 000000000..2d26d2a11 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md @@ -0,0 +1,91 @@ +--- +id: v2024-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfile', 'V2024AccessProfile'] +slug: /tools/sdk/python/v2024/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] +--- + +# AccessProfile + +Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Access Profile | [optional] [readonly] +**name** | **str** | Name of the Access Profile | [required] +**description** | **str** | Information about the Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] +**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**access_request_config** | [**Requestability**](requestability) | | [optional] +**revocation_request_config** | [**Revocability**](revocability) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile import AccessProfile + +access_profile = AccessProfile( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +created='2021-03-01T22:32:58.104Z', +modified='2021-03-02T20:22:28.104Z', +enabled=True, +owner=sailpoint.v2024.models.owner_reference.OwnerReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +source=sailpoint.v2024.models.access_profile_source_ref.AccessProfileSourceRef( + id = '2c91809773dee3610173fdb0b6061ef4', + type = 'SOURCE', + name = 'ODS-AD-SOURCE', ), +entitlements=[ + sailpoint.v2024.models.entitlement_ref.EntitlementRef( + type = 'ENTITLEMENT', + id = '2c91809773dee32014e13e122092014e', + name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', ) + ], +requestable=True, +access_request_config=sailpoint.v2024.models.requestability.Requestability( + comments_required = True, + denial_comments_required = True, + approval_schemes = [ + sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +revocation_request_config=sailpoint.v2024.models.revocability.Revocability( + approval_schemes = [ + sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +provisioning_criteria=sailpoint.v2024.models.provisioning_criteria_level1.ProvisioningCriteriaLevel1( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v2024.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2( + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..19b953e63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileApprovalScheme', 'V2024AccessProfileApprovalScheme'] +slug: /tools/sdk/python/v2024/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024AccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **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.access_profile_approval_scheme import AccessProfileApprovalScheme + +access_profile_approval_scheme = AccessProfileApprovalScheme( +approver_type='GOVERNANCE_GROUP', +approver_id='46c79819-a69f-49a2-becb-12c971ae66c6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..979522f31 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteRequest', 'V2024AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/python/v2024/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'V2024AccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_profile_ids** | **[]str** | List of IDs of Access Profiles to be deleted. | [optional] +**best_effort_only** | **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest + +access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest( +access_profile_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816], +best_effort_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..28e016fc4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,46 @@ +--- +id: v2024-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteResponse', 'V2024AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/python/v2024/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'V2024AccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_id** | **str** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional] +**pending** | **[]str** | List of IDs of Access Profiles which are pending deletion. | [optional] +**in_use** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse + +access_profile_bulk_delete_response = AccessProfileBulkDeleteResponse( +task_id='2c9180867817ac4d017817c491119a20', +pending=[2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816], +in_use=[ + sailpoint.v2024.models.access_profile_usage.AccessProfileUsage( + access_profile_id = '2c91808876438bbb017668c21919ecca', + used_by = [ + sailpoint.v2024.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner( + type = 'ROLE', + id = '2c8180857a9b3da0017aa03418480f9d', + name = 'Manager Role', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..1ce558e89 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,36 @@ +--- +id: v2024-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'V2024AccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/python/v2024/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'V2024AccessProfileBulkUpdateRequestInner'] +--- + +# AccessProfileBulkUpdateRequestInner + +Access Profile's basic details. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Access Profile ID. | [optional] +**requestable** | **bool** | Access Profile is requestable or not. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner + +access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner( +id='464ae7bf-791e-49fd-b746-06a2e4a8', +requestable=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDetails.md new file mode 100644 index 000000000..0e8b412fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDetails.md @@ -0,0 +1,85 @@ +--- +id: v2024-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDetails', 'V2024AccessProfileDetails'] +slug: /tools/sdk/python/v2024/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'V2024AccessProfileDetails'] +--- + +# AccessProfileDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Access Profile | [optional] +**name** | **str** | Name of the Access Profile | [optional] +**description** | **str** | Information about the Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created | [optional] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] +**disabled** | **bool** | Whether the Access Profile is enabled. | [optional] [default to True] +**requestable** | **bool** | Whether the Access Profile is requestable via access request. | [optional] [default to False] +**protected** | **bool** | Whether the Access Profile is protected. | [optional] [default to False] +**owner_id** | **str** | The owner ID of the Access Profile | [optional] +**source_id** | **int** | The source ID of the Access Profile | [optional] +**source_name** | **str** | The source name of the Access Profile | [optional] +**app_id** | **int** | The source app ID of the Access Profile | [optional] +**app_name** | **str** | The source app name of the Access Profile | [optional] +**application_id** | **str** | The id of the application | [optional] +**type** | **str** | The type of the access profile | [optional] +**entitlements** | **[]str** | List of IDs of entitlements | [optional] +**entitlement_count** | **int** | The number of entitlements in the access profile | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**approval_schemes** | **str** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**revoke_request_approval_schemes** | **str** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**request_comments_required** | **bool** | Whether the access profile require request comment for access request. | [optional] [default to False] +**denied_comments_required** | **bool** | Whether denied comment is required when access request is denied. | [optional] [default to False] +**account_selector** | [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_details import AccessProfileDetails + +access_profile_details = AccessProfileDetails( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +created='2021-03-01T22:32:58.104Z', +modified='2021-03-02T20:22:28.104Z', +disabled=True, +requestable=True, +protected=False, +owner_id='9870808a7190d06e01719938fcd20792', +source_id=10360661, +source_name='AD Source', +app_id=10360661, +app_name='mail app', +application_id='edcb0951812949d085b60cd8bf35bc78', +type='source', +entitlements=[2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9], +entitlement_count=12, +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +approval_schemes='accessProfileOwner', +revoke_request_approval_schemes='accessProfileOwner', +request_comments_required=True, +denied_comments_required=True, +account_selector=sailpoint.v2024.models.access_profile_details_account_selector.AccessProfileDetails_accountSelector( + selectors = [ + sailpoint.v2024.models.selector.selector( + application_id = '2c91808874ff91550175097daaec161c"', + account_match_config = sailpoint.v2024.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ), ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..df1bc5815 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDetailsAccountSelector', 'V2024AccessProfileDetailsAccountSelector'] +slug: /tools/sdk/python/v2024/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'V2024AccessProfileDetailsAccountSelector'] +--- + +# AccessProfileDetailsAccountSelector + +How to select account when there are multiple accounts for the user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selectors** | [**[]Selector**](selector) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_details_account_selector import AccessProfileDetailsAccountSelector + +access_profile_details_account_selector = AccessProfileDetailsAccountSelector( +selectors=[ + sailpoint.v2024.models.selector.selector( + application_id = '2c91808874ff91550175097daaec161c"', + account_match_config = sailpoint.v2024.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocument.md new file mode 100644 index 000000000..d06974e1f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocument.md @@ -0,0 +1,96 @@ +--- +id: v2024-access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDocument', 'V2024AccessProfileDocument'] +slug: /tools/sdk/python/v2024/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'V2024AccessProfileDocument'] +--- + +# AccessProfileDocument + +More complete representation of an access profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Access item's description. | [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] +**synced** | **datetime** | 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] +**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False] +**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True] +**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False] +**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional] +**id** | **str** | Access profile's ID. | [required] +**name** | **str** | Access profile's name. | [required] +**source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional] +**entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional] +**entitlement_count** | **int** | Number of entitlements. | [optional] +**segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional] +**segment_count** | **int** | Number of segments with the access profile. | [optional] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_document import AccessProfileDocument + +access_profile_document = AccessProfileDocument( +description='Admin access', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:33.104Z', +enabled=True, +requestable=True, +request_comments_required=False, +owner=sailpoint.v2024.models.base_access_owner.BaseAccess_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', + email = 'cloud-support@sailpoint.com', ), +id='2c9180825a6c1adc015a71c9023f0818', +name='Cloud Eng', +source=sailpoint.v2024.models.access_profile_document_all_of_source.AccessProfileDocument_allOf_source( + id = 'ff8081815757d4fb0157588f3d9d008f', + name = 'Employees', ), +entitlements=[ + sailpoint.v2024.models.base_entitlement.BaseEntitlement( + has_permissions = False, + description = 'Cloud engineering', + attribute = 'memberOf', + value = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', + schema = 'group', + privileged = False, + id = '2c918084575812550157589064f33b89', + name = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', ) + ], +entitlement_count=5, +segments=[ + sailpoint.v2024.models.base_segment.BaseSegment( + id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', + name = 'Test Segment', ) + ], +segment_count=1, +tags=[TAG_1, TAG_2], +apps=[ + sailpoint.v2024.models.access_apps.AccessApps( + id = '2c91808568c529c60168cca6f90c1313', + name = 'Travel and Expense', + description = 'Travel and Expense Application', + owner = sailpoint.v2024.models.access_apps_owner.AccessApps_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'John Doe', + email = 'john.doe@sailpoint.com', ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..5819d0e78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,36 @@ +--- +id: v2024-access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDocumentAllOfSource', 'V2024AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/python/v2024/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'V2024AccessProfileDocumentAllOfSource'] +--- + +# AccessProfileDocumentAllOfSource + +Access profile's source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Source's ID. | [optional] +**name** | **str** | Source's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_document_all_of_source import AccessProfileDocumentAllOfSource + +access_profile_document_all_of_source = AccessProfileDocumentAllOfSource( +id='ff8081815757d4fb0157588f3d9d008f', +name='Employees' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileEntitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..b65b93b49 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileEntitlement.md @@ -0,0 +1,54 @@ +--- +id: v2024-access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileEntitlement', 'V2024AccessProfileEntitlement'] +slug: /tools/sdk/python/v2024/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'V2024AccessProfileEntitlement'] +--- + +# AccessProfileEntitlement + +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.access_profile_entitlement import AccessProfileEntitlement + +access_profile_entitlement = AccessProfileEntitlement( +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/AccessProfileRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileRef.md new file mode 100644 index 000000000..35adbd914 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileRef', 'V2024AccessProfileRef'] +slug: /tools/sdk/python/v2024/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'V2024AccessProfileRef'] +--- + +# AccessProfileRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the Access Profile | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE' ] | 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. | [optional] +**name** | **str** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_ref import AccessProfileRef + +access_profile_ref = AccessProfileRef( +id='ff808081751e6e129f1518161919ecca', +type='ACCESS_PROFILE', +name='Access Profile 2567' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileRole.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileRole.md new file mode 100644 index 000000000..d9369e341 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileRole.md @@ -0,0 +1,48 @@ +--- +id: v2024-access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileRole', 'V2024AccessProfileRole'] +slug: /tools/sdk/python/v2024/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'V2024AccessProfileRole'] +--- + +# AccessProfileRole + +Role + +## 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] +**owner** | [**DisplayReference**](display-reference) | | [optional] +**disabled** | **bool** | | [optional] +**revocable** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_role import AccessProfileRole + +access_profile_role = AccessProfileRole( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ROLE', +owner=, +disabled=True, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..07b625ee3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileSourceRef', 'V2024AccessProfileSourceRef'] +slug: /tools/sdk/python/v2024/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024AccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] +**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] +**name** | **str** | The display name of the associated Source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_source_ref import AccessProfileSourceRef + +access_profile_source_ref = AccessProfileSourceRef( +id='2c91809773dee3610173fdb0b6061ef4', +type='SOURCE', +name='ODS-AD-SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSummary.md new file mode 100644 index 000000000..d1f621171 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSummary.md @@ -0,0 +1,50 @@ +--- +id: v2024-access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileSummary', 'V2024AccessProfileSummary'] +slug: /tools/sdk/python/v2024/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'V2024AccessProfileSummary'] +--- + +# AccessProfileSummary + +This is a summary representation of an access profile. + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_summary import AccessProfileSummary + +access_profile_summary = AccessProfileSummary( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ACCESS_PROFILE', +source=sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +owner=, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..42d53d919 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUpdateItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUpdateItem', 'V2024AccessProfileUpdateItem'] +slug: /tools/sdk/python/v2024/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'V2024AccessProfileUpdateItem'] +--- + +# AccessProfileUpdateItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of Access Profile in bulk update request. | [required] +**requestable** | **bool** | Access Profile requestable or not. | [required] +**status** | **str** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_update_item import AccessProfileUpdateItem + +access_profile_update_item = AccessProfileUpdateItem( +id='2c7180a46faadee4016fb4e018c20642', +requestable=False, +status='201', +description=' +> Access profile is updated successfully. + +> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUsage.md new file mode 100644 index 000000000..6e0df699c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUsage.md @@ -0,0 +1,40 @@ +--- +id: v2024-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUsage', 'V2024AccessProfileUsage'] +slug: /tools/sdk/python/v2024/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'V2024AccessProfileUsage'] +--- + +# AccessProfileUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_profile_id** | **str** | ID of the Access Profile that is in use | [optional] +**used_by** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_usage import AccessProfileUsage + +access_profile_usage = AccessProfileUsage( +access_profile_id='2c91808876438bbb017668c21919ecca', +used_by=[ + sailpoint.v2024.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner( + type = 'ROLE', + id = '2c8180857a9b3da0017aa03418480f9d', + name = 'Manager Role', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..e6fe274d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUsageUsedByInner', 'V2024AccessProfileUsageUsedByInner'] +slug: /tools/sdk/python/v2024/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'V2024AccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +Role using the access profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ROLE' ] | DTO type of role using the access profile. | [optional] +**id** | **str** | ID of role using the access profile. | [optional] +**name** | **str** | Display name of role using the access profile. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_profile_usage_used_by_inner import AccessProfileUsageUsedByInner + +access_profile_usage_used_by_inner = AccessProfileUsageUsedByInner( +type='ROLE', +id='2c8180857a9b3da0017aa03418480f9d', +name='Manager Role' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRecommendationMessage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..0159ae269 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRecommendationMessage.md @@ -0,0 +1,33 @@ +--- +id: v2024-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRecommendationMessage', 'V2024AccessRecommendationMessage'] +slug: /tools/sdk/python/v2024/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'V2024AccessRecommendationMessage'] +--- + +# AccessRecommendationMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**interpretation** | **str** | Information about why the access item was recommended. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_recommendation_message import AccessRecommendationMessage + +access_recommendation_message = AccessRecommendationMessage( +interpretation='95% of your peers have this access.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md new file mode 100644 index 000000000..15f69bbb5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md @@ -0,0 +1,48 @@ +--- +id: v2024-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequest', 'V2024AccessRequest'] +slug: /tools/sdk/python/v2024/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'V2024AccessRequest'] +--- + +# AccessRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request import AccessRequest + +access_request = AccessRequest( +requested_for=[ + '2c918084660f45d6016617daa9210584' + ], +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.v2024.models.access_request_item.AccessRequestItem( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestAdminItemStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestAdminItemStatus.md new file mode 100644 index 000000000..697d5e103 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestAdminItemStatus.md @@ -0,0 +1,138 @@ +--- +id: v2024-access-request-admin-item-status +title: AccessRequestAdminItemStatus +pagination_label: AccessRequestAdminItemStatus +sidebar_label: AccessRequestAdminItemStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestAdminItemStatus', 'V2024AccessRequestAdminItemStatus'] +slug: /tools/sdk/python/v2024/models/access-request-admin-item-status +tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2024AccessRequestAdminItemStatus'] +--- + +# AccessRequestAdminItemStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. | [optional] +**name** | **str** | Human-readable display name of the item being requested. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional] +**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**account_activity_item_id** | **str** | Id of associated account activity item. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**description** | **str** | Description associated to the requested object. | [optional] +**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional] +**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False] +**reauthorization_required** | **bool** | True if re-auth is required. | [optional] [default to False] +**access_request_id** | **str** | This is the account activity id. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus + +access_request_admin_item_status = AccessRequestAdminItemStatus( +id='2c9180926cbfbddd016cbfc7c3b10010', +name='AccessProfile1', +type='ACCESS_PROFILE', +cancelled_request_details=, +error_messages=[ + {locale=en-US, localeOrigin=DEFAULT, text=Error Message} + ], +state='EXECUTING', +approval_details=[ + sailpoint.v2024.models.approval_status_dto.ApprovalStatusDto( + forwarded = False, + original_owner = sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = null, + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + scheme = 'MANAGER', + error_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.', ) + ], + comment = 'I approve this request', + remove_date = '2020-07-11T00:00Z', ) + ], +manual_work_item_details=[ + sailpoint.v2024.models.manual_work_item_details.ManualWorkItemDetails( + forwarded = True, + original_owner = sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = sailpoint.v2024.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + forward_history = [ + sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], ) + ], +account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010', +request_type='GRANT_ACCESS', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +requester=sailpoint.v2024.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v2024.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +requester_comment=, +sod_violation_context=, +provisioning_details=, +pre_approval_trigger_details=, +access_request_phases=[ + sailpoint.v2024.models.access_request_phases.AccessRequestPhases( + started = '2020-07-11T00:00Z', + finished = '2020-07-12T00:00Z', + name = 'APPROVAL_PHASE', + state = 'COMPLETED', + result = 'SUCCESSFUL', + phase_reference = 'approvalDetails', ) + ], +description='This is the Engineering role that engineers are granted.', +remove_date='2019-10-23T00:00Z', +cancelable=True, +reauthorization_required=True, +access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +client_metadata={key1=value1, key2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestApproversListResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestApproversListResponse.md new file mode 100644 index 000000000..eb9f2f1d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestApproversListResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-approvers-list-response +title: AccessRequestApproversListResponse +pagination_label: AccessRequestApproversListResponse +sidebar_label: AccessRequestApproversListResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestApproversListResponse', 'V2024AccessRequestApproversListResponse'] +slug: /tools/sdk/python/v2024/models/access-request-approvers-list-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestApproversListResponse', 'V2024AccessRequestApproversListResponse'] +--- + +# AccessRequestApproversListResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Approver id. | [optional] +**email** | **str** | Email of the approver. | [optional] +**name** | **str** | Name of the approver. | [optional] +**approval_id** | **str** | Id of the approval item. | [optional] +**type** | **str** | Type of the object returned. In this case, the value for this field will always Identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_approvers_list_response import AccessRequestApproversListResponse + +access_request_approvers_list_response = AccessRequestApproversListResponse( +id='id12345', +email='jdoe@sailpoint.com', +name='John Doe', +approval_id='ap12345', +type='Identity' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestConfig.md new file mode 100644 index 000000000..6372e5a51 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestConfig.md @@ -0,0 +1,57 @@ +--- +id: v2024-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestConfig', 'V2024AccessRequestConfig'] +slug: /tools/sdk/python/v2024/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'V2024AccessRequestConfig'] +--- + +# AccessRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvals_must_be_external** | **bool** | 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. | [optional] [default to False] +**auto_approval_enabled** | **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to False] +**reauthorization_enabled** | **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to False] +**request_on_behalf_of_config** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**approval_reminder_and_escalation_config** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**entitlement_request_config** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_config import AccessRequestConfig + +access_request_config = AccessRequestConfig( +approvals_must_be_external=True, +auto_approval_enabled=True, +reauthorization_enabled=True, +request_on_behalf_of_config=sailpoint.v2024.models.request_on_behalf_of_config.RequestOnBehalfOfConfig( + allow_request_on_behalf_of_anyone_by_anyone = True, + allow_request_on_behalf_of_employee_by_manager = True, ), +approval_reminder_and_escalation_config=sailpoint.v2024.models.approval_reminder_and_escalation_config.ApprovalReminderAndEscalationConfig( + days_until_escalation = 0, + days_between_reminders = 0, + max_reminders = 1, + fallback_approver_ref = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), ), +entitlement_request_config=sailpoint.v2024.models.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/AccessRequestContext.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestContext.md new file mode 100644 index 000000000..fed07d75c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestContext.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestContext', 'V2024AccessRequestContext'] +slug: /tools/sdk/python/v2024/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'V2024AccessRequestContext'] +--- + +# AccessRequestContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context_attributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_context import AccessRequestContext + +access_request_context = AccessRequestContext( +context_attributes=[ + sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..5cfbaa2b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,55 @@ +--- +id: v2024-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApprover', 'V2024AccessRequestDynamicApprover'] +slug: /tools/sdk/python/v2024/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'V2024AccessRequestDynamicApprover'] +--- + +# AccessRequestDynamicApprover + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | 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. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_dynamic_approver import AccessRequestDynamicApprover + +access_request_dynamic_approver = AccessRequestDynamicApprover( +access_request_id='4b4d982dddff4267ab12f0f1e72b5a6d', +requested_for=[ + sailpoint.v2024.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items=[ + sailpoint.v2024.models.access_request_dynamic_approver_requested_items_inner.AccessRequestDynamicApprover_requestedItems_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Engineering Access', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access for his day to day job activities.', ) + ], +requested_by=sailpoint.v2024.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..2b28be816 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApprover1', 'V2024AccessRequestDynamicApprover1'] +slug: /tools/sdk/python/v2024/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'V2024AccessRequestDynamicApprover1'] +--- + +# AccessRequestDynamicApprover1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity to add to the approver list for the access request. | [required] +**name** | **str** | The name of the identity to add to the approver list for the access request. | [required] +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The type of object being referenced. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_dynamic_approver1 import AccessRequestDynamicApprover1 + +access_request_dynamic_approver1 = AccessRequestDynamicApprover1( +id='2c91808b6ef1d43e016efba0ce470906', +name='Adam Adams', +type=IDENTITY +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..84753df49 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2024AccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/python/v2024/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2024AccessRequestDynamicApproverRequestedItemsInner'] +--- + +# AccessRequestDynamicApproverRequestedItemsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the access item. | [required] +**name** | **str** | Human friendly name of the access item. | [required] +**description** | **str** | Extended description of the access item. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item being requested. | [required] +**operation** | **Enum** [ 'Add', 'Remove' ] | Grant or revoke the access item | [required] +**comment** | **str** | A comment from the requestor on why the access is needed. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_dynamic_approver_requested_items_inner import AccessRequestDynamicApproverRequestedItemsInner + +access_request_dynamic_approver_requested_items_inner = AccessRequestDynamicApproverRequestedItemsInner( +id='2c91808b6ef1d43e016efba0ce470904', +name='Engineering Access', +description='Engineering Access', +type=ACCESS_PROFILE, +operation=Add, +comment='William needs this access for his day to day job activities.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md new file mode 100644 index 000000000..b5ed66db1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItem', 'V2024AccessRequestItem'] +slug: /tools/sdk/python/v2024/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'V2024AccessRequestItem'] +--- + +# AccessRequestItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | 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. | [optional] +**remove_date** | **datetime** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_item import AccessRequestItem + +access_request_item = AccessRequestItem( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItemResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..f2c928f98 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItemResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse'] +slug: /tools/sdk/python/v2024/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse'] +--- + +# AccessRequestItemResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **str** | the access request item operation | [optional] +**access_item_type** | **str** | the access item type | [optional] +**name** | **str** | the name of access request item | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | the final decision for the access request | [optional] +**description** | **str** | the description of access request item | [optional] +**source_id** | **str** | the source id | [optional] +**source_name** | **str** | the source Name | [optional] +**approval_infos** | [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_item_response import AccessRequestItemResponse + +access_request_item_response = AccessRequestItemResponse( +operation='Add', +access_item_type='role', +name='Role-1', +decision='APPROVED', +description='The role descrition', +source_id='8a80828f643d484f01643e14202e206f', +source_name='Source1', +approval_infos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPhases.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPhases.md new file mode 100644 index 000000000..26c429855 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPhases.md @@ -0,0 +1,44 @@ +--- +id: v2024-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPhases', 'V2024AccessRequestPhases'] +slug: /tools/sdk/python/v2024/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'V2024AccessRequestPhases'] +--- + +# AccessRequestPhases + +Provides additional details about this access request phase. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**started** | **datetime** | The time that this phase started. | [optional] +**finished** | **datetime** | The time that this phase finished. | [optional] +**name** | **str** | The name of this phase. | [optional] +**state** | **Enum** [ 'PENDING', 'EXECUTING', 'COMPLETED', 'CANCELLED', 'NOT_EXECUTED' ] | The state of this phase. | [optional] +**result** | **Enum** [ 'SUCCESSFUL', 'FAILED' ] | The state of this phase. | [optional] +**phase_reference** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_phases import AccessRequestPhases + +access_request_phases = AccessRequestPhases( +started='2020-07-11T00:00Z', +finished='2020-07-12T00:00Z', +name='APPROVAL_PHASE', +state='COMPLETED', +result='SUCCESSFUL', +phase_reference='approvalDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApproval.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..e21c251c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApproval.md @@ -0,0 +1,64 @@ +--- +id: v2024-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApproval', 'V2024AccessRequestPostApproval'] +slug: /tools/sdk/python/v2024/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'V2024AccessRequestPostApproval'] +--- + +# AccessRequestPostApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | The unique ID of the access request. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_post_approval import AccessRequestPostApproval + +access_request_post_approval = AccessRequestPostApproval( +access_request_id='2c91808b6ef1d43e016efba0ce470904', +requested_for=[ + sailpoint.v2024.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items_status=[ + sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner.AccessRequestPostApproval_requestedItemsStatus_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', + client_metadata = {applicationName=My application}, + approval_info = [ + sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner( + approval_comment = 'This access looks good. Approved.', + approval_decision = APPROVED, + approver_name = 'Stephen.Austin', + approver = sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ), ) + ], ) + ], +requested_by=sailpoint.v2024.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..6ee4a01f6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,54 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/python/v2024/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the access item being requested. | [required] +**name** | **str** | The human friendly name of the access item. | [required] +**description** | **str** | Detailed description of the access item. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required] +**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required] +**comment** | **str** | A comment from the identity requesting the access. | [optional] +**client_metadata** | **map[string]object** | Additional customer defined metadata about the access item. | [optional] +**approval_info** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner import AccessRequestPostApprovalRequestedItemsStatusInner + +access_request_post_approval_requested_items_status_inner = AccessRequestPostApprovalRequestedItemsStatusInner( +id='2c91808b6ef1d43e016efba0ce470904', +name='Engineering Access', +description='Access to engineering database', +type=ACCESS_PROFILE, +operation=Add, +comment='William needs this access to do his job.', +client_metadata={applicationName=My application}, +approval_info=[ + sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner( + approval_comment = 'This access looks good. Approved.', + approval_decision = APPROVED, + approver_name = 'Stephen.Austin', + approver = sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..a54b1179b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,40 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/python/v2024/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_comment** | **str** | A comment left by the approver. | [optional] +**approval_decision** | **Enum** [ 'APPROVED', 'DENIED' ] | The final decision of the approver. | [required] +**approver_name** | **str** | The name of the approver | [required] +**approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +access_request_post_approval_requested_items_status_inner_approval_info_inner = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner( +approval_comment='This access looks good. Approved.', +approval_decision=APPROVED, +approver_name='Stephen.Austin', +approver=sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 000000000..739e45fa7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,38 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +slug: /tools/sdk/python/v2024/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +The identity of the approver. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [required] +**id** | **str** | ID of identity who approved the access item request. | [required] +**name** | **str** | Human-readable display name of identity who approved the access item request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +access_request_post_approval_requested_items_status_inner_approval_info_inner_approver = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover( +type=IDENTITY, +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApproval.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..09b576a72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApproval.md @@ -0,0 +1,55 @@ +--- +id: v2024-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApproval', 'V2024AccessRequestPreApproval'] +slug: /tools/sdk/python/v2024/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'V2024AccessRequestPreApproval'] +--- + +# AccessRequestPreApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | The unique ID of the access request. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_pre_approval import AccessRequestPreApproval + +access_request_pre_approval = AccessRequestPreApproval( +access_request_id='2c91808b6ef1d43e016efba0ce470904', +requested_for=[ + sailpoint.v2024.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items=[ + sailpoint.v2024.models.access_request_pre_approval_requested_items_inner.AccessRequestPreApproval_requestedItems_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', ) + ], +requested_by=sailpoint.v2024.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..7c04861fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApproval1.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApproval1', 'V2024AccessRequestPreApproval1'] +slug: /tools/sdk/python/v2024/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'V2024AccessRequestPreApproval1'] +--- + +# AccessRequestPreApproval1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **bool** | Whether or not to approve the access request. | [required] +**comment** | **str** | A comment about the decision to approve or deny the request. | [required] +**approver** | **str** | The name of the entity that approved or denied the request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_pre_approval1 import AccessRequestPreApproval1 + +access_request_pre_approval1 = AccessRequestPreApproval1( +approved=False, +comment='This access should be denied, because this will cause an SOD violation.', +approver='AcmeCorpExternalIntegration' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..cf0b55502 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'V2024AccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/python/v2024/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'V2024AccessRequestPreApprovalRequestedItemsInner'] +--- + +# AccessRequestPreApprovalRequestedItemsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the access item being requested. | [required] +**name** | **str** | The human friendly name of the access item. | [required] +**description** | **str** | Detailed description of the access item. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required] +**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required] +**comment** | **str** | A comment from the identity requesting the access. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_pre_approval_requested_items_inner import AccessRequestPreApprovalRequestedItemsInner + +access_request_pre_approval_requested_items_inner = AccessRequestPreApprovalRequestedItemsInner( +id='2c91808b6ef1d43e016efba0ce470904', +name='Engineering Access', +description='Access to engineering database', +type=ACCESS_PROFILE, +operation=Add, +comment='William needs this access to do his job.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..de7d1b68a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationActionItemDto', 'V2024AccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'V2024AccessRequestRecommendationActionItemDto'] +--- + +# AccessRequestRecommendationActionItemDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID taking the action. | [required] +**access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto + +access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto( +identity_id='2c91808570313110017040b06f344ec9', +access=sailpoint.v2024.models.access_request_recommendation_item.AccessRequestRecommendationItem( + id = '2c9180835d2e5168015d32f890ca1581', + type = 'ACCESS_PROFILE', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..5b0d27644 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'V2024AccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'V2024AccessRequestRecommendationActionItemResponseDto'] +--- + +# AccessRequestRecommendationActionItemResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID taking the action. | [optional] +**access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**timestamp** | **datetime** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + +access_request_recommendation_action_item_response_dto = AccessRequestRecommendationActionItemResponseDto( +identity_id='2c91808570313110017040b06f344ec9', +access=sailpoint.v2024.models.access_request_recommendation_item.AccessRequestRecommendationItem( + id = '2c9180835d2e5168015d32f890ca1581', + type = 'ACCESS_PROFILE', ), +timestamp='2017-07-11T18:45:37.098Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md new file mode 100644 index 000000000..ba2f171c1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-request-recommendation-config-dto +title: AccessRequestRecommendationConfigDto +pagination_label: AccessRequestRecommendationConfigDto +sidebar_label: AccessRequestRecommendationConfigDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] +--- + +# AccessRequestRecommendationConfigDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**score_threshold** | **float** | The value that internal calculations need to exceed for recommendations to be made. | [required] +**start_date_attribute** | **str** | Use to map an attribute name for determining identities' start date. | [optional] +**restriction_attribute** | **str** | Use to only give recommendations based on this attribute. | [optional] +**mover_attribute** | **str** | Use to map an attribute name for determining whether identities are movers. | [optional] +**joiner_attribute** | **str** | Use to map an attribute name for determining whether identities are joiners. | [optional] +**use_restriction_attribute** | **bool** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto + +access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto( +score_threshold=0.5, +start_date_attribute='startDate', +restriction_attribute='location', +mover_attribute='isMover', +joiner_attribute='isJoiner', +use_restriction_attribute=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..76cec9bf0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItem', 'V2024AccessRequestRecommendationItem'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'V2024AccessRequestRecommendationItem'] +--- + +# AccessRequestRecommendationItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of access item being recommended. | [optional] +**type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_recommendation_item import AccessRequestRecommendationItem + +access_request_recommendation_item = AccessRequestRecommendationItem( +id='2c9180835d2e5168015d32f890ca1581', +type='ACCESS_PROFILE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..3116c2fe8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,52 @@ +--- +id: v2024-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemDetail', 'V2024AccessRequestRecommendationItemDetail'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'V2024AccessRequestRecommendationItemDetail'] +--- + +# AccessRequestRecommendationItemDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity ID for the recommendation | [optional] +**access** | [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**ignored** | **bool** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**requested** | **bool** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**viewed** | **bool** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**messages** | [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**translation_messages** | [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail + +access_request_recommendation_item_detail = AccessRequestRecommendationItemDetail( +identity_id='2c91808570313110017040b06f344ec9', +access=sailpoint.v2024.models.access_request_recommendation_item_detail_access.AccessRequestRecommendationItemDetail_access( + id = '2c9180835d2e5168015d32f890ca1581', + type = 'ACCESS_PROFILE', + name = 'Employee-database-read-write', + description = 'This item grants an employee read and write access to the database', ), +ignored=True, +requested=True, +viewed=True, +messages=[ + sailpoint.v2024.models.access_recommendation_message.AccessRecommendationMessage( + interpretation = '95% of your peers have this access.', ) + ], +translation_messages=[{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..acc69e00d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'V2024AccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'V2024AccessRequestRecommendationItemDetailAccess'] +--- + +# AccessRequestRecommendationItemDetailAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of access item being recommended. | [optional] +**type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**name** | **str** | Name of the access item | [optional] +**description** | **str** | Description of the access item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_recommendation_item_detail_access import AccessRequestRecommendationItemDetailAccess + +access_request_recommendation_item_detail_access = AccessRequestRecommendationItemDetailAccess( +id='2c9180835d2e5168015d32f890ca1581', +type='ACCESS_PROFILE', +name='Employee-database-read-write', +description='This item grants an employee read and write access to the database' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..11fca81e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,23 @@ +--- +id: v2024-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemType', 'V2024AccessRequestRecommendationItemType'] +slug: /tools/sdk/python/v2024/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'V2024AccessRequestRecommendationItemType'] +--- + +# AccessRequestRecommendationItemType + +The type of access item. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse.md new file mode 100644 index 000000000..2239c8254 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse', 'V2024AccessRequestResponse'] +slug: /tools/sdk/python/v2024/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'V2024AccessRequestResponse'] +--- + +# AccessRequestResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**existing_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_response import AccessRequestResponse + +access_request_response = AccessRequestResponse( +new_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}], +existing_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse1.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..b2937925e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse1.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse1', 'V2024AccessRequestResponse1'] +slug: /tools/sdk/python/v2024/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'V2024AccessRequestResponse1'] +--- + +# AccessRequestResponse1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requester_id** | **str** | the requester Id | [optional] +**requester_name** | **str** | the requesterName | [optional] +**items** | [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_response1 import AccessRequestResponse1 + +access_request_response1 = AccessRequestResponse1( +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}]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestTracking.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestTracking.md new file mode 100644 index 000000000..478e34473 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestTracking.md @@ -0,0 +1,42 @@ +--- +id: v2024-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestTracking', 'V2024AccessRequestTracking'] +slug: /tools/sdk/python/v2024/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'V2024AccessRequestTracking'] +--- + +# AccessRequestTracking + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **str** | The identity id in which the access request is for. | [optional] +**requested_items_details** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**attributes_hash** | **str** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**access_request_ids** | **[]str** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_request_tracking import AccessRequestTracking + +access_request_tracking = AccessRequestTracking( +requested_for='2c918084660f45d6016617daa9210584', +requested_items_details={ +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" + }, +attributes_hash='-1928438224', +access_request_ids=[5d3118c518a44ec7805450d53479ccdb] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestType.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestType.md new file mode 100644 index 000000000..4e610b019 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestType.md @@ -0,0 +1,23 @@ +--- +id: v2024-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestType', 'V2024AccessRequestType'] +slug: /tools/sdk/python/v2024/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'V2024AccessRequestType'] +--- + +# AccessRequestType + +Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. + +## Enum + +* `GRANT_ACCESS` (value: `'GRANT_ACCESS'`) + +* `REVOKE_ACCESS` (value: `'REVOKE_ACCESS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequested.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequested.md new file mode 100644 index 000000000..fe2f3d0ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequested.md @@ -0,0 +1,42 @@ +--- +id: v2024-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequested', 'V2024AccessRequested'] +slug: /tools/sdk/python/v2024/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2024AccessRequested'] +--- + +# AccessRequested + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional] +**identity_id** | **str** | the identity id | [optional] +**event_type** | **str** | the event type | [optional] +**dt** | **str** | the date of event | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_requested import AccessRequested + +access_requested = AccessRequested( +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}]}], ), +identity_id='8a80828f643d484f01643e14202e206f', +event_type='AccessRequested', +dt='2019-03-08T22:37:33.901Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessReviewItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessReviewItem.md new file mode 100644 index 000000000..73fa51920 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessReviewItem.md @@ -0,0 +1,144 @@ +--- +id: v2024-access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessReviewItem', 'V2024AccessReviewItem'] +slug: /tools/sdk/python/v2024/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'V2024AccessReviewItem'] +--- + +# AccessReviewItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_summary** | [**AccessSummary**](access-summary) | | [optional] +**identity_summary** | [**CertificationIdentitySummary**](certification-identity-summary) | | [optional] +**id** | **str** | The review item's id | [optional] +**completed** | **bool** | Whether the review item is complete | [optional] +**new_access** | **bool** | Indicates whether the review item is for new access to a source | [optional] +**decision** | [**CertificationDecision**](certification-decision) | | [optional] +**comments** | **str** | Comments for this review item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_review_item import AccessReviewItem + +access_review_item = AccessReviewItem( +access_summary=sailpoint.v2024.models.access_summary.AccessSummary( + access = sailpoint.v2024.models.access_summary_access.AccessSummary_access( + type = 'IDENTITY', + id = '2c9180867160846801719932c5153fb7', + name = 'Entitlement for Company Database', ), + entitlement = sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ), + access_profile = sailpoint.v2024.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + entitlements = [ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ), + role = sailpoint.v2024.models.reviewable_role.ReviewableRole( + id = '2c91808a7190d06e0171993907fd0794', + name = 'Accounting-Employees', + description = 'Role for members of the accounting department with the necessary Access Profiles', + privileged = False, + revocable = False, + end_date = '2021-12-25T00:00Z', + access_profiles = [ + sailpoint.v2024.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ) + ], ), ), +identity_summary=sailpoint.v2024.models.certification_identity_summary.CertificationIdentitySummary( + id = '2c91808772a504f50172a9540e501ba7', + name = 'Alison Ferguso', + identity_id = '2c9180857182306001719937377a33de', + completed = True, ), +id='ef38f94347e94562b5bb8424a56397d8', +completed=False, +new_access=False, +decision='APPROVE', +comments='This user still needs access to this source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessReviewReassignment.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..38edee5f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessReviewReassignment.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessReviewReassignment', 'V2024AccessReviewReassignment'] +slug: /tools/sdk/python/v2024/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'V2024AccessReviewReassignment'] +--- + +# AccessReviewReassignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign** | [**[]ReassignReference**](reassign-reference) | | [required] +**reassign_to** | **str** | The ID of the identity to which the certification is reassigned | [required] +**reason** | **str** | The reason comment for why the reassign was made | [required] +} + +## Example + +```python +from sailpoint.v2024.models.access_review_reassignment import AccessReviewReassignment + +access_review_reassignment = AccessReviewReassignment( +reassign=[ + sailpoint.v2024.models.reassign_reference.ReassignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'ITEM', ) + ], +reassign_to='ef38f94347e94562b5bb8424a56397d8', +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessSummary.md new file mode 100644 index 000000000..e0cbb0ec8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessSummary.md @@ -0,0 +1,233 @@ +--- +id: v2024-access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessSummary', 'V2024AccessSummary'] +slug: /tools/sdk/python/v2024/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'V2024AccessSummary'] +--- + +# AccessSummary + +An object holding the access that is being reviewed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | [**AccessSummaryAccess**](access-summary-access) | | [optional] +**entitlement** | [**ReviewableEntitlement**](reviewable-entitlement) | | [optional] +**access_profile** | [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional] +**role** | [**ReviewableRole**](reviewable-role) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_summary import AccessSummary + +access_summary = AccessSummary( +access=sailpoint.v2024.models.access_summary_access.AccessSummary_access( + type = 'IDENTITY', + id = '2c9180867160846801719932c5153fb7', + name = 'Entitlement for Company Database', ), +entitlement=sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ), +access_profile=sailpoint.v2024.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + entitlements = [ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ), +role=sailpoint.v2024.models.reviewable_role.ReviewableRole( + id = '2c91808a7190d06e0171993907fd0794', + name = 'Accounting-Employees', + description = 'Role for members of the accounting department with the necessary Access Profiles', + privileged = False, + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + revocable = False, + end_date = '2021-12-25T00:00Z', + access_profiles = [ + sailpoint.v2024.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + entitlements = [ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ) + ], + entitlements = [ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessSummaryAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..307fdbb62 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessSummaryAccess.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessSummaryAccess', 'V2024AccessSummaryAccess'] +slug: /tools/sdk/python/v2024/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'V2024AccessSummaryAccess'] +--- + +# AccessSummaryAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The ID of the item being certified | [optional] +**name** | **str** | The name of the item being certified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.access_summary_access import AccessSummaryAccess + +access_summary_access = AccessSummaryAccess( +type='IDENTITY', +id='2c9180867160846801719932c5153fb7', +name='Entitlement for Company Database' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessType.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessType.md new file mode 100644 index 000000000..c52dfef3e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessType.md @@ -0,0 +1,23 @@ +--- +id: v2024-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessType', 'V2024AccessType'] +slug: /tools/sdk/python/v2024/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'V2024AccessType'] +--- + +# AccessType + +Access type of API Client indicating online or offline use + +## Enum + +* `ONLINE` (value: `'ONLINE'`) + +* `OFFLINE` (value: `'OFFLINE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Account.md b/docs/tools/sdk/python/Reference/V2024/Models/Account.md new file mode 100644 index 000000000..cc6490933 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Account.md @@ -0,0 +1,93 @@ +--- +id: v2024-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account', 'V2024Account'] +slug: /tools/sdk/python/v2024/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'V2024Account'] +--- + +# Account + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**source_id** | **str** | The unique ID of the source this account belongs to | [required] +**source_name** | **str** | The display name of the source this account belongs to | [required] +**identity_id** | **str** | The unique ID of the identity this account is correlated to | [optional] +**cloud_lifecycle_state** | **str** | The lifecycle state of the identity this account is correlated to | [optional] +**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional] +**connection_type** | **str** | The connection type of the source this account is from | [optional] +**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False] +**recommendation** | [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional] +**attributes** | **map[string]object** | The account attributes that are aggregated | [required] +**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required] +**description** | **str** | A description of the account | [optional] +**disabled** | **bool** | Indicates if the account is currently disabled | [required] +**locked** | **bool** | Indicates if the account is currently locked | [required] +**native_identity** | **str** | The unique ID of the account generated by the source system | [required] +**system_account** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required] +**uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | [required] +**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional] +**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required] +**has_entitlements** | **bool** | Indicates if the account has entitlements | [required] +**identity** | [**AccountAllOfIdentity**](account-all-of-identity) | | [optional] +**source_owner** | [**AccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional] +**features** | **str** | A string list containing the owning source's features | [optional] +**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional] +**owner_identity** | [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account import Account + +account = Account( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +source_id='2c9180835d2e5168015d32f890ca1581', +source_name='Employees', +identity_id='2c9180835d2e5168015d32f890ca1581', +cloud_lifecycle_state='active', +identity_state='ACTIVE', +connection_type='direct', +is_machine=True, +recommendation=, +attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support}, +authoritative=False, +description='', +disabled=False, +locked=False, +native_identity='552775', +system_account=False, +uncorrelated=False, +uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}', +manually_correlated=False, +has_entitlements=True, +identity=sailpoint.v2024.models.account_all_of_identity.Account_allOf_identity( + id = '2c918084660f45d6016617daa9210584', + type = 'IDENTITY', + name = 'John Doe', ), +source_owner=sailpoint.v2024.models.account_all_of_source_owner.Account_allOf_sourceOwner( + id = '2c918084660f45d6016617daa9210584', + type = 'IDENTITY', + name = 'Adam Kennedy', ), +features='ENABLE', +origin='AGGREGATED', +owner_identity= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAction.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAction.md new file mode 100644 index 000000000..3b7ee074a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAction.md @@ -0,0 +1,36 @@ +--- +id: v2024-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAction', 'V2024AccountAction'] +slug: /tools/sdk/python/v2024/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'V2024AccountAction'] +--- + +# AccountAction + +Object for specifying Actions to be performed on a specified list of sources' account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **Enum** [ 'ENABLE', 'DISABLE' ] | Describes if action will be enabled or disabled | [optional] +**source_ids** | **[]str** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_action import AccountAction + +account_action = AccountAction( +action='ENABLE', +source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountActivity.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivity.md new file mode 100644 index 000000000..2b3b3ffe4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivity.md @@ -0,0 +1,100 @@ +--- +id: v2024-account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivity', 'V2024AccountActivity'] +slug: /tools/sdk/python/v2024/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'V2024AccountActivity'] +--- + +# AccountActivity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the account activity | [optional] +**name** | **str** | The name of the activity | [optional] +**created** | **datetime** | When the activity was first created | [optional] +**modified** | **datetime** | When the activity was last modified | [optional] +**completed** | **datetime** | When the activity was completed | [optional] +**completion_status** | [**CompletionStatus**](completion-status) | | [optional] +**type** | **str** | 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). | [optional] +**requester_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**target_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**errors** | **[]str** | A list of error messages, if any, that were encountered. | [optional] +**warnings** | **[]str** | A list of warning messages, if any, that were encountered. | [optional] +**items** | [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional] +**execution_status** | [**ExecutionStatus**](execution-status) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_activity import AccountActivity + +account_activity = AccountActivity( +id='2c9180835d2e5168015d32f890ca1581', +name='2c9180835d2e5168015d32f890ca1581', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +completed='2018-10-19T13:49:37.385Z', +completion_status='SUCCESS', +type='appRequest', +requester_identity_summary=sailpoint.v2024.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +target_identity_summary=sailpoint.v2024.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +errors=[sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.], +warnings=[Some warning, another warning], +items=[ + sailpoint.v2024.models.account_activity_item.AccountActivityItem( + id = '48c545831b264409a81befcabb0e3c5a', + name = '48c545831b264409a81befcabb0e3c5a', + requested = '2017-07-11T18:45:37.098Z', + approval_status = 'PENDING', + provisioning_status = 'PENDING', + requester_comment = sailpoint.v2024.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), + reviewer_identity_summary = sailpoint.v2024.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), + reviewer_comment = sailpoint.v2024.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), + operation = 'ADD', + attribute = 'detectedRoles', + value = 'Treasury Analyst [AccessProfile-1529010191212]', + native_identity = 'Sandie.Camero', + source_id = '2c91808363ef85290164000587130c0c', + account_request_info = sailpoint.v2024.models.account_request_info.AccountRequestInfo( + requested_object_id = '2c91808563ef85690164001c31140c0c', + requested_object_name = 'Treasury Analyst', + requested_object_type = 'ACCESS_PROFILE', ), + client_metadata = {customKey1=custom value 1, customKey2=custom value 2}, + remove_date = '2020-07-11T00:00Z', ) + ], +execution_status='COMPLETED', +client_metadata={customKey1=custom value 1, customKey2=custom value 2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..22f0c6faa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,31 @@ +--- +id: v2024-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityApprovalStatus', 'V2024AccountActivityApprovalStatus'] +slug: /tools/sdk/python/v2024/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'V2024AccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +The state of an approval status + +## Enum + +* `FINISHED` (value: `'FINISHED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `RETURNED` (value: `'RETURNED'`) + +* `EXPIRED` (value: `'EXPIRED'`) + +* `PENDING` (value: `'PENDING'`) + +* `CANCELED` (value: `'CANCELED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityDocument.md new file mode 100644 index 000000000..cec453015 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityDocument.md @@ -0,0 +1,138 @@ +--- +id: v2024-account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityDocument', 'V2024AccountActivityDocument'] +slug: /tools/sdk/python/v2024/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'V2024AccountActivityDocument'] +--- + +# AccountActivityDocument + +AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of account activity. | [optional] +**action** | **str** | Type of action performed in the activity. | [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] +**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] +**stage** | **str** | Activity's current stage. | [optional] +**status** | **str** | Activity's current status. | [optional] +**requester** | [**ActivityIdentity**](activity-identity) | | [optional] +**recipient** | [**ActivityIdentity**](activity-identity) | | [optional] +**tracking_number** | **str** | Account activity's tracking number. | [optional] +**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional] +**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional] +**approvals** | [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**original_requests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**expansion_items** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**account_requests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**sources** | **str** | Sources involved in the account activity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_activity_document import AccountActivityDocument + +account_activity_document = AccountActivityDocument( +id='2c91808375d8e80a0175e1f88a575222', +action='Identity Refresh.', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +stage='Completed', +status='Complete', +requester=, +recipient=, +tracking_number='61aad0c9e8134eca89e76a35e0cabe3f', +errors=[ + '' + ], +warnings=[ + '' + ], +approvals=[ + sailpoint.v2024.models.approval_1.Approval_1( + comments = [ + sailpoint.v2024.models.approval_comment_2.ApprovalComment_2( + comment = 'This request was autoapproved by our automated ETS subscriber.', + commenter = 'Automated AR Approval', + date = '2018-06-25T20:22:28.104Z', ) + ], + modified = '2018-06-25T20:22:28.104Z', + owner = null, + result = 'Finished', + attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), + source = null, ) + ], +original_requests=[ + sailpoint.v2024.models.original_request.OriginalRequest( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + result = sailpoint.v2024.models.result.Result( + status = 'Manual Task Created', ), + attribute_requests = [ + sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'add', + source = null, ) + ], +expansion_items=[ + sailpoint.v2024.models.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 = null, + id = 'ac2887ffe0e7435a8c18c73f7ae94c7b', + state = 'EXECUTING', ) + ], +account_requests=[ + sailpoint.v2024.models.account_request.AccountRequest( + account_id = 'John.Doe', + attribute_requests = [ + sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'Modify', + provisioning_target = null, + result = sailpoint.v2024.models.account_request_result.AccountRequest_result( + errors = [ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], + status = 'failed', + ticket_id = '', ), + source = null, ) + ], +sources='smartsheet-test, airtable-v4, IdentityNow' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityItem.md new file mode 100644 index 000000000..599d5bccc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityItem.md @@ -0,0 +1,78 @@ +--- +id: v2024-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityItem', 'V2024AccountActivityItem'] +slug: /tools/sdk/python/v2024/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'V2024AccountActivityItem'] +--- + +# AccountActivityItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Item id | [optional] +**name** | **str** | Human-readable display name of item | [optional] +**requested** | **datetime** | Date and time item was requested | [optional] +**approval_status** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**provisioning_status** | [**ProvisioningState**](provisioning-state) | | [optional] +**requester_comment** | [**Comment**](comment) | | [optional] +**reviewer_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**reviewer_comment** | [**Comment**](comment) | | [optional] +**operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**attribute** | **str** | Attribute to which account activity applies | [optional] +**value** | **str** | Value of attribute | [optional] +**native_identity** | **str** | Native identity in the target system to which the account activity applies | [optional] +**source_id** | **str** | Id of Source to which account activity applies | [optional] +**account_request_info** | [**AccountRequestInfo**](account-request-info) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_activity_item import AccountActivityItem + +account_activity_item = AccountActivityItem( +id='48c545831b264409a81befcabb0e3c5a', +name='48c545831b264409a81befcabb0e3c5a', +requested='2017-07-11T18:45:37.098Z', +approval_status='PENDING', +provisioning_status='PENDING', +requester_comment=sailpoint.v2024.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), +reviewer_identity_summary=sailpoint.v2024.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +reviewer_comment=sailpoint.v2024.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), +operation='ADD', +attribute='detectedRoles', +value='Treasury Analyst [AccessProfile-1529010191212]', +native_identity='Sandie.Camero', +source_id='2c91808363ef85290164000587130c0c', +account_request_info=sailpoint.v2024.models.account_request_info.AccountRequestInfo( + requested_object_id = '2c91808563ef85690164001c31140c0c', + requested_object_name = 'Treasury Analyst', + requested_object_type = 'ACCESS_PROFILE', ), +client_metadata={customKey1=custom value 1, customKey2=custom value 2}, +remove_date='2020-07-11T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityItemOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..d207de3f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivityItemOperation.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityItemOperation', 'V2024AccountActivityItemOperation'] +slug: /tools/sdk/python/v2024/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'V2024AccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +Represents an operation in an account activity item + +## Enum + +* `ADD` (value: `'ADD'`) + +* `CREATE` (value: `'CREATE'`) + +* `MODIFY` (value: `'MODIFY'`) + +* `DELETE` (value: `'DELETE'`) + +* `DISABLE` (value: `'DISABLE'`) + +* `ENABLE` (value: `'ENABLE'`) + +* `UNLOCK` (value: `'UNLOCK'`) + +* `LOCK` (value: `'LOCK'`) + +* `REMOVE` (value: `'REMOVE'`) + +* `SET` (value: `'SET'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..008f35b76 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountActivitySearchedItem.md @@ -0,0 +1,138 @@ +--- +id: v2024-account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivitySearchedItem', 'V2024AccountActivitySearchedItem'] +slug: /tools/sdk/python/v2024/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'V2024AccountActivitySearchedItem'] +--- + +# AccountActivitySearchedItem + +AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of account activity. | [optional] +**action** | **str** | Type of action performed in the activity. | [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] +**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] +**stage** | **str** | Activity's current stage. | [optional] +**status** | **str** | Activity's current status. | [optional] +**requester** | [**ActivityIdentity**](activity-identity) | | [optional] +**recipient** | [**ActivityIdentity**](activity-identity) | | [optional] +**tracking_number** | **str** | Account activity's tracking number. | [optional] +**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional] +**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional] +**approvals** | [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**original_requests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**expansion_items** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**account_requests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**sources** | **str** | Sources involved in the account activity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_activity_searched_item import AccountActivitySearchedItem + +account_activity_searched_item = AccountActivitySearchedItem( +id='2c91808375d8e80a0175e1f88a575222', +action='Identity Refresh.', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +stage='Completed', +status='Complete', +requester=, +recipient=, +tracking_number='61aad0c9e8134eca89e76a35e0cabe3f', +errors=[ + '' + ], +warnings=[ + '' + ], +approvals=[ + sailpoint.v2024.models.approval_1.Approval_1( + comments = [ + sailpoint.v2024.models.approval_comment_2.ApprovalComment_2( + comment = 'This request was autoapproved by our automated ETS subscriber.', + commenter = 'Automated AR Approval', + date = '2018-06-25T20:22:28.104Z', ) + ], + modified = '2018-06-25T20:22:28.104Z', + owner = null, + result = 'Finished', + attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), + source = null, ) + ], +original_requests=[ + sailpoint.v2024.models.original_request.OriginalRequest( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + result = sailpoint.v2024.models.result.Result( + status = 'Manual Task Created', ), + attribute_requests = [ + sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'add', + source = null, ) + ], +expansion_items=[ + sailpoint.v2024.models.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 = null, + id = 'ac2887ffe0e7435a8c18c73f7ae94c7b', + state = 'EXECUTING', ) + ], +account_requests=[ + sailpoint.v2024.models.account_request.AccountRequest( + account_id = 'John.Doe', + attribute_requests = [ + sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'Modify', + provisioning_target = null, + result = sailpoint.v2024.models.account_request_result.AccountRequest_result( + errors = [ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], + status = 'failed', + ticket_id = '', ), + source = null, ) + ], +sources='smartsheet-test, airtable-v4, IdentityNow' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompleted.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..8a75b74ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompleted.md @@ -0,0 +1,57 @@ +--- +id: v2024-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompleted', 'V2024AccountAggregationCompleted'] +slug: /tools/sdk/python/v2024/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'V2024AccountAggregationCompleted'] +--- + +# AccountAggregationCompleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required] +**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the aggregation. | [required] +**started** | **datetime** | The date and time when the account aggregation started. | [required] +**completed** | **datetime** | The date and time when the account aggregation finished. | [required] +**errors** | **[]str** | A list of errors that occurred during the aggregation. | [required] +**warnings** | **[]str** | A list of warnings that occurred during the aggregation. | [required] +**stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_aggregation_completed import AccountAggregationCompleted + +account_aggregation_completed = AccountAggregationCompleted( +source=sailpoint.v2024.models.account_aggregation_completed_source.AccountAggregationCompleted_source( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +status=Success, +started='2020-06-29T22:01:50.474Z', +completed='2020-06-29T22:02:04.090Z', +errors=[ + 'Accounts unable to be aggregated.' + ], +warnings=[ + 'Account Skipped' + ], +stats=sailpoint.v2024.models.account_aggregation_completed_stats.AccountAggregationCompleted_stats( + scanned = 200, + unchanged = 190, + changed = 6, + added = 4, + removed = 3, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..76ba333e6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompletedSource', 'V2024AccountAggregationCompletedSource'] +slug: /tools/sdk/python/v2024/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'V2024AccountAggregationCompletedSource'] +--- + +# AccountAggregationCompletedSource + +The source the accounts are being aggregated from. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being aggregated from. | [required] +**id** | **str** | The ID of the source the accounts are being aggregated from. | [required] +**name** | **str** | Display name of the source the accounts are being aggregated from. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_aggregation_completed_source import AccountAggregationCompletedSource + +account_aggregation_completed_source = AccountAggregationCompletedSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..6f2ce963d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,42 @@ +--- +id: v2024-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompletedStats', 'V2024AccountAggregationCompletedStats'] +slug: /tools/sdk/python/v2024/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'V2024AccountAggregationCompletedStats'] +--- + +# AccountAggregationCompletedStats + +Overall statistics about the account aggregation. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required] +**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required] +**changed** | **int** | The number of accounts which existed before, but had changes. | [required] +**added** | **int** | The number of accounts which are new - have not existed before. | [required] +**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_aggregation_completed_stats import AccountAggregationCompletedStats + +account_aggregation_completed_stats = AccountAggregationCompletedStats( +scanned=200, +unchanged=190, +changed=6, +added=4, +removed=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..e02b470e1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAggregationStatus.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAggregationStatus', 'V2024AccountAggregationStatus'] +slug: /tools/sdk/python/v2024/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'V2024AccountAggregationStatus'] +--- + +# AccountAggregationStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **datetime** | When the aggregation started. | [optional] +**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED', 'NOT_FOUND' ] | 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. | [optional] +**total_accounts** | **int** | 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.* | [optional] +**processed_accounts** | **int** | 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.* | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_aggregation_status import AccountAggregationStatus + +account_aggregation_status = AccountAggregationStatus( +start='2021-01-31T14:30:05.104Z', +status='ACCOUNTS_COLLECTED', +total_accounts=520, +processed_accounts=150 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfIdentity.md new file mode 100644 index 000000000..0634aac45 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-all-of-identity +title: AccountAllOfIdentity +pagination_label: AccountAllOfIdentity +sidebar_label: AccountAllOfIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity'] +slug: /tools/sdk/python/v2024/models/account-all-of-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity'] +--- + +# AccountAllOfIdentity + +The identity this account is correlated to + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the identity | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional] +**name** | **str** | display name of identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_all_of_identity import AccountAllOfIdentity + +account_all_of_identity = AccountAllOfIdentity( +id='2c918084660f45d6016617daa9210584', +type='IDENTITY', +name='John Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfOwnerIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfOwnerIdentity.md new file mode 100644 index 000000000..affb4fc36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfOwnerIdentity.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-all-of-owner-identity +title: AccountAllOfOwnerIdentity +pagination_label: AccountAllOfOwnerIdentity +sidebar_label: AccountAllOfOwnerIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity'] +slug: /tools/sdk/python/v2024/models/account-all-of-owner-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity'] +--- + +# AccountAllOfOwnerIdentity + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.account_all_of_owner_identity import AccountAllOfOwnerIdentity + +account_all_of_owner_identity = AccountAllOfOwnerIdentity( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfRecommendation.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfRecommendation.md new file mode 100644 index 000000000..75a7147b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfRecommendation.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-all-of-recommendation +title: AccountAllOfRecommendation +pagination_label: AccountAllOfRecommendation +sidebar_label: AccountAllOfRecommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation'] +slug: /tools/sdk/python/v2024/models/account-all-of-recommendation +tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation'] +--- + +# AccountAllOfRecommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required] +**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_all_of_recommendation import AccountAllOfRecommendation + +account_all_of_recommendation = AccountAllOfRecommendation( +type='MACHINE', +method='DISCOVERY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfSourceOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfSourceOwner.md new file mode 100644 index 000000000..38b803740 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfSourceOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-all-of-source-owner +title: AccountAllOfSourceOwner +pagination_label: AccountAllOfSourceOwner +sidebar_label: AccountAllOfSourceOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner'] +slug: /tools/sdk/python/v2024/models/account-all-of-source-owner +tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner'] +--- + +# AccountAllOfSourceOwner + +The owner of the source this account belongs to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the identity | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional] +**name** | **str** | display name of identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_all_of_source_owner import AccountAllOfSourceOwner + +account_all_of_source_owner = AccountAllOfSourceOwner( +id='2c918084660f45d6016617daa9210584', +type='IDENTITY', +name='Adam Kennedy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributes.md new file mode 100644 index 000000000..430aa2e6c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributes.md @@ -0,0 +1,33 @@ +--- +id: v2024-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributes', 'V2024AccountAttributes'] +slug: /tools/sdk/python/v2024/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'V2024AccountAttributes'] +--- + +# AccountAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **map[string]object** | The schema attribute values for the account | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes import AccountAttributes + +account_attributes = AccountAttributes( +attributes={city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChanged.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..b3c6ebbe7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChanged.md @@ -0,0 +1,55 @@ +--- +id: v2024-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChanged', 'V2024AccountAttributesChanged'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'V2024AccountAttributesChanged'] +--- + +# AccountAttributesChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required] +**source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required] +**account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required] +**changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed import AccountAttributesChanged + +account_attributes_changed = AccountAttributesChanged( +identity=sailpoint.v2024.models.account_attributes_changed_identity.AccountAttributesChanged_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +source=sailpoint.v2024.models.account_attributes_changed_source.AccountAttributesChanged_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), +account=sailpoint.v2024.models.account_attributes_changed_account.AccountAttributesChanged_account( + id = '52170a74-ca89-11ea-87d0-0242ac130003', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', + name = 'john.doe', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + type = ACCOUNT, ), +changes=[ + sailpoint.v2024.models.account_attributes_changed_changes_inner.AccountAttributesChanged_changes_inner( + attribute = 'sn', + old_value = doe, + new_value = ryans, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..44ad669c6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,42 @@ +--- +id: v2024-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedAccount', 'V2024AccountAttributesChangedAccount'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'V2024AccountAttributesChangedAccount'] +--- + +# AccountAttributesChangedAccount + +Details of the account where the attributes changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | SailPoint generated unique identifier. | [required] +**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [required] +**name** | **str** | Name of the account. | [required] +**native_identity** | **str** | Unique ID of the account on the source. | [required] +**type** | **Enum** [ 'ACCOUNT' ] | The type of the account | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed_account import AccountAttributesChangedAccount + +account_attributes_changed_account = AccountAttributesChangedAccount( +id='52170a74-ca89-11ea-87d0-0242ac130003', +uuid='1cb1f07d-3e5a-4431-becd-234fa4306108', +name='john.doe', +native_identity='cn=john.doe,ou=users,dc=acme,dc=com', +type=ACCOUNT +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..e2faeaa06 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInner', 'V2024AccountAttributesChangedChangesInner'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'V2024AccountAttributesChangedChangesInner'] +--- + +# AccountAttributesChangedChangesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **str** | The name of the attribute. | [required] +**old_value** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required] +**new_value** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed_changes_inner import AccountAttributesChangedChangesInner + +account_attributes_changed_changes_inner = AccountAttributesChangedChangesInner( +attribute='sn', +old_value=doe, +new_value=ryans +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..2ea314cd8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'V2024AccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'V2024AccountAttributesChangedChangesInnerNewValue'] +--- + +# AccountAttributesChangedChangesInnerNewValue + +The new value of the attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed_changes_inner_new_value import AccountAttributesChangedChangesInnerNewValue + +account_attributes_changed_changes_inner_new_value = AccountAttributesChangedChangesInnerNewValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..baba21720 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'V2024AccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'V2024AccountAttributesChangedChangesInnerOldValue'] +--- + +# AccountAttributesChangedChangesInnerOldValue + +The previous value of the attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed_changes_inner_old_value import AccountAttributesChangedChangesInnerOldValue + +account_attributes_changed_changes_inner_old_value = AccountAttributesChangedChangesInnerOldValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..2d3592269 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedIdentity', 'V2024AccountAttributesChangedIdentity'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'V2024AccountAttributesChangedIdentity'] +--- + +# AccountAttributesChangedIdentity + +The identity whose account attributes were updated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity whose account attributes were updated. | [required] +**id** | **str** | ID of the identity whose account attributes were updated. | [required] +**name** | **str** | Display name of the identity whose account attributes were updated. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed_identity import AccountAttributesChangedIdentity + +account_attributes_changed_identity = AccountAttributesChangedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..a3b17704d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesChangedSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedSource', 'V2024AccountAttributesChangedSource'] +slug: /tools/sdk/python/v2024/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'V2024AccountAttributesChangedSource'] +--- + +# AccountAttributesChangedSource + +The source that contains the account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the object to which this reference applies | [required] +**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required] +**name** | **str** | Human-readable display name of the object to which this reference applies | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_changed_source import AccountAttributesChangedSource + +account_attributes_changed_source = AccountAttributesChangedSource( +id='4e4d982dddff4267ab12f0f1e72b5a6d', +type='SOURCE', +name='Corporate Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesCreate.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..47a0cc6fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesCreate.md @@ -0,0 +1,33 @@ +--- +id: v2024-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreate', 'V2024AccountAttributesCreate'] +slug: /tools/sdk/python/v2024/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'V2024AccountAttributesCreate'] +--- + +# AccountAttributesCreate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_create import AccountAttributesCreate + +account_attributes_create = AccountAttributesCreate( +attributes={sourceId=34bfcbe116c9407464af37acbaf7a4dc, city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..61eb247d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,34 @@ +--- +id: v2024-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreateAttributes', 'V2024AccountAttributesCreateAttributes'] +slug: /tools/sdk/python/v2024/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'V2024AccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +The schema attribute values for the account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | Target source to create an account | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_attributes_create_attributes import AccountAttributesCreateAttributes + +account_attributes_create_attributes = AccountAttributesCreateAttributes( +source_id='34bfcbe116c9407464af37acbaf7a4dc' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelated.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelated.md new file mode 100644 index 000000000..50701087d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelated.md @@ -0,0 +1,52 @@ +--- +id: v2024-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelated', 'V2024AccountCorrelated'] +slug: /tools/sdk/python/v2024/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'V2024AccountCorrelated'] +--- + +# AccountCorrelated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required] +**source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required] +**account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required] +**attributes** | **map[string]object** | The attributes associated with the account. Attributes are unique per source. | [required] +**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_correlated import AccountCorrelated + +account_correlated = AccountCorrelated( +identity=sailpoint.v2024.models.account_correlated_identity.AccountCorrelated_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +source=sailpoint.v2024.models.account_correlated_source.AccountCorrelated_source( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +account=sailpoint.v2024.models.account_correlated_account.AccountCorrelated_account( + type = 'ACCOUNT', + id = '98da47c31df444558c211f9b205184f6', + name = 'Brian Mendoza', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ), +attributes={sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]}, +entitlement_count=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..8223cabf1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedAccount.md @@ -0,0 +1,42 @@ +--- +id: v2024-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedAccount', 'V2024AccountCorrelatedAccount'] +slug: /tools/sdk/python/v2024/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'V2024AccountCorrelatedAccount'] +--- + +# AccountCorrelatedAccount + +The correlated account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT' ] | The correlated account's DTO type. | [required] +**id** | **str** | The correlated account's ID. | [required] +**name** | **str** | The correlated account's display name. | [required] +**native_identity** | **str** | Unique ID of the account on the source. | [required] +**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_correlated_account import AccountCorrelatedAccount + +account_correlated_account = AccountCorrelatedAccount( +type='ACCOUNT', +id='98da47c31df444558c211f9b205184f6', +name='Brian Mendoza', +native_identity='cn=john.doe,ou=users,dc=acme,dc=com', +uuid='1cb1f07d-3e5a-4431-becd-234fa4306108' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..32c5439ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedIdentity', 'V2024AccountCorrelatedIdentity'] +slug: /tools/sdk/python/v2024/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'V2024AccountCorrelatedIdentity'] +--- + +# AccountCorrelatedIdentity + +Identity the account is correlated with. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity the account is correlated with. | [required] +**id** | **str** | ID of the identity the account is correlated with. | [required] +**name** | **str** | Display name of the identity the account is correlated with. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_correlated_identity import AccountCorrelatedIdentity + +account_correlated_identity = AccountCorrelatedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..54d40f3fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountCorrelatedSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedSource', 'V2024AccountCorrelatedSource'] +slug: /tools/sdk/python/v2024/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'V2024AccountCorrelatedSource'] +--- + +# AccountCorrelatedSource + +The source the accounts are being correlated from. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being correlated from. | [required] +**id** | **str** | The ID of the source the accounts are being correlated from. | [required] +**name** | **str** | Display name of the source the accounts are being correlated from. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_correlated_source import AccountCorrelatedSource + +account_correlated_source = AccountCorrelatedSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoDto.md new file mode 100644 index 000000000..584420d91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountInfoDto', 'V2024AccountInfoDto'] +slug: /tools/sdk/python/v2024/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'V2024AccountInfoDto'] +--- + +# AccountInfoDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**native_identity** | **str** | The unique ID of the account generated by the source system | [optional] +**display_name** | **str** | Display name for this account | [optional] +**uuid** | **str** | UUID associated with this account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_info_dto import AccountInfoDto + +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}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountRequest.md new file mode 100644 index 000000000..06b33a2ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountRequest.md @@ -0,0 +1,62 @@ +--- +id: v2024-account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequest', 'V2024AccountRequest'] +slug: /tools/sdk/python/v2024/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'V2024AccountRequest'] +--- + +# AccountRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Unique ID of the account | [optional] +**attribute_requests** | [**[]AttributeRequest**](attribute-request) | | [optional] +**op** | **str** | The operation that was performed | [optional] +**provisioning_target** | [**AccountSource**](account-source) | | [optional] +**result** | [**AccountRequestResult**](account-request-result) | | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_request import AccountRequest + +account_request = AccountRequest( +account_id='John.Doe', +attribute_requests=[ + sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], +op='Modify', +provisioning_target=, +result=sailpoint.v2024.models.account_request_result.AccountRequest_result( + errors = [ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], + status = 'failed', + ticket_id = '', ), +source= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountRequestInfo.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountRequestInfo.md new file mode 100644 index 000000000..b5124764f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountRequestInfo.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequestInfo', 'V2024AccountRequestInfo'] +slug: /tools/sdk/python/v2024/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'V2024AccountRequestInfo'] +--- + +# AccountRequestInfo + +If an account activity item is associated with an access request, captures details of that request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_object_id** | **str** | Id of requested object | [optional] +**requested_object_name** | **str** | Human-readable name of requested object | [optional] +**requested_object_type** | [**RequestableObjectType**](requestable-object-type) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_request_info import AccountRequestInfo + +account_request_info = AccountRequestInfo( +requested_object_id='2c91808563ef85690164001c31140c0c', +requested_object_name='Treasury Analyst', +requested_object_type='ACCESS_PROFILE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountRequestResult.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountRequestResult.md new file mode 100644 index 000000000..ad2e97688 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountRequestResult.md @@ -0,0 +1,48 @@ +--- +id: v2024-account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequestResult', 'V2024AccountRequestResult'] +slug: /tools/sdk/python/v2024/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountRequestResult'] +--- + +# AccountRequestResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | **[]str** | Error message. | [optional] +**status** | **str** | The status of the account request | [optional] +**ticket_id** | **str** | ID of associated ticket. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_request_result import AccountRequestResult + +account_request_result = AccountRequestResult( +errors=[ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], +status='failed', +ticket_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountSource.md new file mode 100644 index 000000000..154b80800 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountSource', 'V2024AccountSource'] +slug: /tools/sdk/python/v2024/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'V2024AccountSource'] +--- + +# AccountSource + + +## 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] +**type** | **str** | Type of source returned. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_source import AccountSource + +account_source = AccountSource( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +type='Delimited File' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChanged.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChanged.md new file mode 100644 index 000000000..dfdb83d1d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChanged.md @@ -0,0 +1,50 @@ +--- +id: v2024-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountStatusChanged', 'V2024AccountStatusChanged'] +slug: /tools/sdk/python/v2024/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'V2024AccountStatusChanged'] +--- + +# AccountStatusChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **str** | the event type | [optional] +**identity_id** | **str** | the identity id | [optional] +**dt** | **str** | the date of event | [optional] +**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_status_changed import AccountStatusChanged + +account_status_changed = AccountStatusChanged( +event_type='', +identity_id='', +dt='', +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/AccountStatusChangedAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..4684d0878 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedAccount.md @@ -0,0 +1,45 @@ +--- +id: v2024-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount'] +slug: /tools/sdk/python/v2024/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount'] +--- + +# AccountStatusChangedAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the ID of the account in the database | [optional] +**native_identity** | **str** | the native identifier of the account | [optional] +**display_name** | **str** | the display name of the account | [optional] +**source_id** | **str** | the ID of the source for this account | [optional] +**source_name** | **str** | the name of the source for this account | [optional] +**entitlement_count** | **int** | the number of entitlements on this account | [optional] +**access_type** | **str** | this value is always \"account\" | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_status_changed_account import AccountStatusChangedAccount + +account_status_changed_account = AccountStatusChangedAccount( +id='', +native_identity='', +display_name='', +source_id='', +source_name='', +entitlement_count=56, +access_type='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..81f625102 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange'] +slug: /tools/sdk/python/v2024/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange'] +--- + +# AccountStatusChangedStatusChange + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the previous status of the account | [optional] +**new_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the new status of the account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_status_changed_status_change import AccountStatusChangedStatusChange + +account_status_changed_status_change = AccountStatusChangedStatusChange( +previous_status='enabled', +new_status='enabled' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountToggleRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountToggleRequest.md new file mode 100644 index 000000000..07c050838 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountToggleRequest.md @@ -0,0 +1,36 @@ +--- +id: v2024-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountToggleRequest', 'V2024AccountToggleRequest'] +slug: /tools/sdk/python/v2024/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'V2024AccountToggleRequest'] +--- + +# AccountToggleRequest + +Request used for account enable/disable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**force_provisioning** | **bool** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest + +account_toggle_request = AccountToggleRequest( +external_verification_id='3f9180835d2e5168015d32f890ca1581', +force_provisioning=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelated.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelated.md new file mode 100644 index 000000000..9049fbe03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelated.md @@ -0,0 +1,50 @@ +--- +id: v2024-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelated', 'V2024AccountUncorrelated'] +slug: /tools/sdk/python/v2024/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'V2024AccountUncorrelated'] +--- + +# AccountUncorrelated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required] +**source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_uncorrelated import AccountUncorrelated + +account_uncorrelated = AccountUncorrelated( +identity=sailpoint.v2024.models.account_uncorrelated_identity.AccountUncorrelated_identity( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +source=sailpoint.v2024.models.account_uncorrelated_source.AccountUncorrelated_source( + type = 'SOURCE', + id = '2c6180835d191a86015d28455b4b231b', + name = 'Corporate Directory', ), +account=sailpoint.v2024.models.account_uncorrelated_account.AccountUncorrelated_account( + type = ACCOUNT, + id = '4dd497e3723e439991cb6d0e478375dd', + name = 'Sadie Jensen', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ), +entitlement_count=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..cb52009d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,42 @@ +--- +id: v2024-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedAccount', 'V2024AccountUncorrelatedAccount'] +slug: /tools/sdk/python/v2024/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'V2024AccountUncorrelatedAccount'] +--- + +# AccountUncorrelatedAccount + +Uncorrelated account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT' ] | Uncorrelated account's DTO type. | [required] +**id** | **str** | Uncorrelated account's ID. | [required] +**name** | **str** | Uncorrelated account's display name. | [required] +**native_identity** | **str** | Unique ID of the account on the source. | [required] +**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_uncorrelated_account import AccountUncorrelatedAccount + +account_uncorrelated_account = AccountUncorrelatedAccount( +type=ACCOUNT, +id='4dd497e3723e439991cb6d0e478375dd', +name='Sadie Jensen', +native_identity='cn=john.doe,ou=users,dc=acme,dc=com', +uuid='1cb1f07d-3e5a-4431-becd-234fa4306108' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..3799c0281 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedIdentity', 'V2024AccountUncorrelatedIdentity'] +slug: /tools/sdk/python/v2024/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'V2024AccountUncorrelatedIdentity'] +--- + +# AccountUncorrelatedIdentity + +Identity the account is uncorrelated with. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity the account is uncorrelated with. | [required] +**id** | **str** | ID of the identity the account is uncorrelated with. | [required] +**name** | **str** | Display name of the identity the account is uncorrelated with. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_uncorrelated_identity import AccountUncorrelatedIdentity + +account_uncorrelated_identity = AccountUncorrelatedIdentity( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..958b81b6d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUncorrelatedSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedSource', 'V2024AccountUncorrelatedSource'] +slug: /tools/sdk/python/v2024/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'V2024AccountUncorrelatedSource'] +--- + +# AccountUncorrelatedSource + +The source the accounts are uncorrelated from. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are uncorrelated from. | [required] +**id** | **str** | The ID of the source the accounts are uncorrelated from. | [required] +**name** | **str** | Display name of the source the accounts are uncorrelated from. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.account_uncorrelated_source import AccountUncorrelatedSource + +account_uncorrelated_source = AccountUncorrelatedSource( +type='SOURCE', +id='2c6180835d191a86015d28455b4b231b', +name='Corporate Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUnlockRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..5b959b3af --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUnlockRequest.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUnlockRequest', 'V2024AccountUnlockRequest'] +slug: /tools/sdk/python/v2024/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'V2024AccountUnlockRequest'] +--- + +# AccountUnlockRequest + +Request used for account unlock + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**unlock_idn_account** | **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**force_provisioning** | **bool** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_unlock_request import AccountUnlockRequest + +account_unlock_request = AccountUnlockRequest( +external_verification_id='3f9180835d2e5168015d32f890ca1581', +unlock_idn_account=False, +force_provisioning=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md new file mode 100644 index 000000000..442faa748 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUsage', 'V2024AccountUsage'] +slug: /tools/sdk/python/v2024/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'V2024AccountUsage'] +--- + +# AccountUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional] +**count** | **int** | The number of days within the month that the account was active in a source. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_usage import AccountUsage + +account_usage = AccountUsage( +var_date='Thu Apr 20 20:00:00 EDT 2023', +count=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsAsyncResult.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..d06a0c362 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsAsyncResult.md @@ -0,0 +1,34 @@ +--- +id: v2024-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsAsyncResult', 'V2024AccountsAsyncResult'] +slug: /tools/sdk/python/v2024/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'V2024AccountsAsyncResult'] +--- + +# AccountsAsyncResult + +Accounts async response containing details on started async process + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the task | [required] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult + +accounts_async_result = AccountsAsyncResult( +id='2c91808474683da6017468693c260195' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..93e050de4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,57 @@ +--- +id: v2024-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregation', 'V2024AccountsCollectedForAggregation'] +slug: /tools/sdk/python/v2024/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'V2024AccountsCollectedForAggregation'] +--- + +# AccountsCollectedForAggregation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required] +**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the collection. | [required] +**started** | **datetime** | The date and time when the account collection started. | [required] +**completed** | **datetime** | The date and time when the account collection finished. | [required] +**errors** | **[]str** | A list of errors that occurred during the collection. | [required] +**warnings** | **[]str** | A list of warnings that occurred during the collection. | [required] +**stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_collected_for_aggregation import AccountsCollectedForAggregation + +accounts_collected_for_aggregation = AccountsCollectedForAggregation( +source=sailpoint.v2024.models.accounts_collected_for_aggregation_source.AccountsCollectedForAggregation_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), +status=Success, +started='2020-06-29T22:01:50.474Z', +completed='2020-06-29T22:02:04.090Z', +errors=[ + 'Unable to collect accounts for aggregation.' + ], +warnings=[ + 'Account Skipped' + ], +stats=sailpoint.v2024.models.accounts_collected_for_aggregation_stats.AccountsCollectedForAggregation_stats( + scanned = 200, + unchanged = 190, + changed = 6, + added = 4, + removed = 3, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..4659a6084 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregationSource', 'V2024AccountsCollectedForAggregationSource'] +slug: /tools/sdk/python/v2024/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'V2024AccountsCollectedForAggregationSource'] +--- + +# AccountsCollectedForAggregationSource + +Reference to the source that has been aggregated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the object to which this reference applies | [required] +**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required] +**name** | **str** | Human-readable display name of the object to which this reference applies | [required] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_collected_for_aggregation_source import AccountsCollectedForAggregationSource + +accounts_collected_for_aggregation_source = AccountsCollectedForAggregationSource( +id='4e4d982dddff4267ab12f0f1e72b5a6d', +type='SOURCE', +name='Corporate Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..e87916766 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,42 @@ +--- +id: v2024-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregationStats', 'V2024AccountsCollectedForAggregationStats'] +slug: /tools/sdk/python/v2024/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'V2024AccountsCollectedForAggregationStats'] +--- + +# AccountsCollectedForAggregationStats + +Overall statistics about the account collection. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required] +**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required] +**changed** | **int** | The number of accounts which existed before, but had changes. | [required] +**added** | **int** | The number of accounts which are new - have not existed before. | [required] +**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_collected_for_aggregation_stats import AccountsCollectedForAggregationStats + +accounts_collected_for_aggregation_stats = AccountsCollectedForAggregationStats( +scanned=200, +unchanged=190, +changed=6, +added=4, +removed=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsExportReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..b82669c5a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsExportReportArguments.md @@ -0,0 +1,36 @@ +--- +id: v2024-accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsExportReportArguments', 'V2024AccountsExportReportArguments'] +slug: /tools/sdk/python/v2024/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'V2024AccountsExportReportArguments'] +--- + +# AccountsExportReportArguments + +Arguments for Account Export report (ACCOUNTS) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | **str** | Source ID. | [required] +**source_name** | **str** | Source name. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_export_report_arguments import AccountsExportReportArguments + +accounts_export_report_arguments = AccountsExportReportArguments( +application='2c9180897eSourceIde781782f705b9', +source_name='Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ActivateCampaignOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..5acc6dbcf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ActivateCampaignOptions.md @@ -0,0 +1,33 @@ +--- +id: v2024-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivateCampaignOptions', 'V2024ActivateCampaignOptions'] +slug: /tools/sdk/python/v2024/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'V2024ActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time_zone** | **str** | 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. | [optional] [default to 'Z'] +} + +## Example + +```python +from sailpoint.v2024.models.activate_campaign_options import ActivateCampaignOptions + +activate_campaign_options = ActivateCampaignOptions( +time_zone='Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ActivityIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/ActivityIdentity.md new file mode 100644 index 000000000..9380a9281 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ActivityIdentity.md @@ -0,0 +1,37 @@ +--- +id: v2024-activity-identity +title: ActivityIdentity +pagination_label: ActivityIdentity +sidebar_label: ActivityIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivityIdentity', 'V2024ActivityIdentity'] +slug: /tools/sdk/python/v2024/models/activity-identity +tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'V2024ActivityIdentity'] +--- + +# ActivityIdentity + + +## 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] +**type** | **str** | Type of object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.activity_identity import ActivityIdentity + +activity_identity = ActivityIdentity( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +type='Identity' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ActivityInsights.md b/docs/tools/sdk/python/Reference/V2024/Models/ActivityInsights.md new file mode 100644 index 000000000..7e1d473be --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ActivityInsights.md @@ -0,0 +1,38 @@ +--- +id: v2024-activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivityInsights', 'V2024ActivityInsights'] +slug: /tools/sdk/python/v2024/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'V2024ActivityInsights'] +--- + +# ActivityInsights + +Insights into account activity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | UUID of the account | [optional] +**usage_days** | **int** | The number of days of activity | [optional] +**usage_days_state** | **Enum** [ 'COMPLETE', 'UNKNOWN' ] | Status indicating if the activity is complete or unknown | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.activity_insights import ActivityInsights + +activity_insights = ActivityInsights( +account_id='c4ddd5421d8549f0abd309162cafd3b1', +usage_days=45, +usage_days_state='COMPLETE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AdminReviewReassign.md b/docs/tools/sdk/python/Reference/V2024/Models/AdminReviewReassign.md new file mode 100644 index 000000000..55a4e8104 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AdminReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: v2024-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AdminReviewReassign', 'V2024AdminReviewReassign'] +slug: /tools/sdk/python/v2024/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'V2024AdminReviewReassign'] +--- + +# AdminReviewReassign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification_ids** | **[]str** | List of certification IDs to reassign | [optional] +**reassign_to** | [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**reason** | **str** | Comment to explain why the certification was reassigned | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.admin_review_reassign import AdminReviewReassign + +admin_review_reassign = AdminReviewReassign( +certification_ids=[af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3], +reassign_to=sailpoint.v2024.models.admin_review_reassign_reassign_to.AdminReviewReassign_reassignTo( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'IDENTITY', ), +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/python/Reference/V2024/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..8a1713423 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,35 @@ +--- +id: v2024-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AdminReviewReassignReassignTo', 'V2024AdminReviewReassignReassignTo'] +slug: /tools/sdk/python/v2024/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'V2024AdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID to which the review is being assigned. | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the ID provided. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.admin_review_reassign_reassign_to import AdminReviewReassignReassignTo + +admin_review_reassign_reassign_to = AdminReviewReassignReassignTo( +id='ef38f94347e94562b5bb8424a56397d8', +type='IDENTITY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AggregationResult.md b/docs/tools/sdk/python/Reference/V2024/Models/AggregationResult.md new file mode 100644 index 000000000..f64102e17 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AggregationResult.md @@ -0,0 +1,37 @@ +--- +id: v2024-aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AggregationResult', 'V2024AggregationResult'] +slug: /tools/sdk/python/v2024/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024AggregationResult'] +--- + +# AggregationResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregations** | **object** | 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. | [optional] +**hits** | **[]object** | The results of the aggregation search query. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.aggregation_result import AggregationResult + +aggregation_result = AggregationResult( +aggregations={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=[ + sailpoint.v2024.models.search_documents.SearchDocuments() + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AggregationType.md b/docs/tools/sdk/python/Reference/V2024/Models/AggregationType.md new file mode 100644 index 000000000..059ae59d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AggregationType.md @@ -0,0 +1,23 @@ +--- +id: v2024-aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AggregationType', 'V2024AggregationType'] +slug: /tools/sdk/python/v2024/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'V2024AggregationType'] +--- + +# AggregationType + +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. + +## Enum + +* `DSL` (value: `'DSL'`) + +* `SAILPOINT` (value: `'SAILPOINT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Aggregations.md b/docs/tools/sdk/python/Reference/V2024/Models/Aggregations.md new file mode 100644 index 000000000..95e3d4caf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Aggregations.md @@ -0,0 +1,53 @@ +--- +id: v2024-aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Aggregations', 'V2024Aggregations'] +slug: /tools/sdk/python/v2024/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'V2024Aggregations'] +--- + +# Aggregations + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | [**NestedAggregation**](nested-aggregation) | | [optional] +**metric** | [**MetricAggregation**](metric-aggregation) | | [optional] +**filter** | [**FilterAggregation**](filter-aggregation) | | [optional] +**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.aggregations import Aggregations + +aggregations = Aggregations( +nested=sailpoint.v2024.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), +metric=sailpoint.v2024.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), +filter=sailpoint.v2024.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + type = 'TERM', + field = 'access.type', + value = 'ENTITLEMENT', ), +bucket=sailpoint.v2024.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + type = 'TERMS', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/App.md b/docs/tools/sdk/python/Reference/V2024/Models/App.md new file mode 100644 index 000000000..67d989a82 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/App.md @@ -0,0 +1,43 @@ +--- +id: v2024-app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'App', 'V2024App'] +slug: /tools/sdk/python/v2024/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'V2024App'] +--- + +# App + + +## 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] +**source** | [**Reference**](reference) | | [optional] +**account** | [**AppAllOfAccount**](app-all-of-account) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.app import App + +app = App( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +source=sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +account=sailpoint.v2024.models.app_all_of_account.App_allOf_account( + id = '2c9180837dfe6949017e21f3d8cd6d49', + account_id = 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AppAccountDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/AppAccountDetails.md new file mode 100644 index 000000000..3af8893fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AppAccountDetails.md @@ -0,0 +1,42 @@ +--- +id: v2024-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AppAccountDetails', 'V2024AppAccountDetails'] +slug: /tools/sdk/python/v2024/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'V2024AppAccountDetails'] +--- + +# AppAccountDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_id** | **str** | The source app ID | [optional] +**app_display_name** | **str** | The source app display name | [optional] +**source_account** | [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.app_account_details import AppAccountDetails + +app_account_details = AppAccountDetails( +app_id='fbf4f72280304f1a8bc808fc2a3bcf7b', +app_display_name='AD source app', +source_account=sailpoint.v2024.models.app_account_details_source_account.AppAccountDetails_sourceAccount( + id = 'fbf4f72280304f1a8bc808fc2a3bcf7b', + native_identity = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + display_name = 'Abby Smith', + source_id = '10efa58ea3954883b52bf74f489ce8f9', + source_display_name = 'ODS-AD-SOURCE', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..e850d1da8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,41 @@ +--- +id: v2024-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AppAccountDetailsSourceAccount', 'V2024AppAccountDetailsSourceAccount'] +slug: /tools/sdk/python/v2024/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'V2024AppAccountDetailsSourceAccount'] +--- + +# AppAccountDetailsSourceAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The account ID | [optional] +**native_identity** | **str** | The native identity of account | [optional] +**display_name** | **str** | The display name of account | [optional] +**source_id** | **str** | The source ID of account | [optional] +**source_display_name** | **str** | The source name of account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.app_account_details_source_account import AppAccountDetailsSourceAccount + +app_account_details_source_account = AppAccountDetailsSourceAccount( +id='fbf4f72280304f1a8bc808fc2a3bcf7b', +native_identity='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +display_name='Abby Smith', +source_id='10efa58ea3954883b52bf74f489ce8f9', +source_display_name='ODS-AD-SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AppAllOfAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/AppAllOfAccount.md new file mode 100644 index 000000000..f1d1d89fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AppAllOfAccount.md @@ -0,0 +1,35 @@ +--- +id: v2024-app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AppAllOfAccount', 'V2024AppAllOfAccount'] +slug: /tools/sdk/python/v2024/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'V2024AppAllOfAccount'] +--- + +# AppAllOfAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The SailPoint generated unique ID | [optional] +**account_id** | **str** | The account ID generated by the source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.app_all_of_account import AppAllOfAccount + +app_all_of_account = AppAllOfAccount( +id='2c9180837dfe6949017e21f3d8cd6d49', +account_id='CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Approval.md b/docs/tools/sdk/python/Reference/V2024/Models/Approval.md new file mode 100644 index 000000000..6bf1b547a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Approval.md @@ -0,0 +1,101 @@ +--- +id: v2024-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Approval', 'V2024Approval'] +slug: /tools/sdk/python/v2024/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'V2024Approval'] +--- + +# Approval + +Approval Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_id** | **str** | The Approval ID | [optional] +**approvers** | [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**created_date** | **str** | Date the approval was created | [optional] +**type** | **str** | Type of approval | [optional] +**name** | [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**batch_request** | [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**priority** | **Enum** [ 'HIGH', 'MEDIUM', 'LOW' ] | The priority of the approval | [optional] +**requester** | [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**comments** | [**[]ApprovalComment1**](approval-comment1) | Object representation of a comment on the approval | [optional] +**approved_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**rejected_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**completed_date** | **str** | Date the approval was completed | [optional] +**approval_criteria** | **Enum** [ 'SINGLE', 'DOUBLE', 'TRIPLE', 'QUARTER', 'HALF', 'ALL' ] | Criteria that needs to be met for an approval to be marked as approved | [optional] +**status** | **Enum** [ 'PENDING', 'APPROVED', 'REJECTED' ] | The current status of the approval | [optional] +**additional_attributes** | **str** | Json string representing additional attributes known about the object to be approved. | [optional] +**reference_data** | [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval import Approval + +approval = Approval( +approval_id='38453251-6be2-5f8f-df93-5ce19e295837', +approvers=[ + sailpoint.v2024.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ) + ], +created_date='2023-04-12T23:20:50.52Z', +type='ENTITLEMENT_DESCRIPTIONS', +name=[ + sailpoint.v2024.models.approval_name.ApprovalName( + value = 'Audit DB Access', + locale = 'en_US', ) + ], +batch_request={batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100}, +description=[ + sailpoint.v2024.models.approval_description.ApprovalDescription( + value = 'This access allows viewing and editing of workflow resource', + locale = 'en_US', ) + ], +priority='HIGH', +requester={id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe}, +comments=[ + sailpoint.v2024.models.approval_comment_1.ApprovalComment_1( + author = sailpoint.v2024.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ), + comment = 'Looks good', + created_date = '2023-04-12T23:20:50.52Z', ) + ], +approved_by=[ + sailpoint.v2024.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ) + ], +rejected_by=[ + sailpoint.v2024.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ) + ], +completed_date='2023-04-12T23:20:50.52Z', +approval_criteria='SINGLE', +status='PENDING', +additional_attributes='{ "llm_description": "generated description" }', +reference_data=[ + sailpoint.v2024.models.approval_reference.ApprovalReference( + id = '64012350-8fd9-4f6c-a170-1fe123683899', + type = 'AccessRequestId', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Approval1.md b/docs/tools/sdk/python/Reference/V2024/Models/Approval1.md new file mode 100644 index 000000000..0b42c8992 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Approval1.md @@ -0,0 +1,51 @@ +--- +id: v2024-approval1 +title: Approval1 +pagination_label: Approval1 +sidebar_label: Approval1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Approval1', 'V2024Approval1'] +slug: /tools/sdk/python/v2024/models/approval1 +tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2024Approval1'] +--- + +# Approval1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments** | [**[]ApprovalComment2**](approval-comment2) | | [optional] +**modified** | **datetime** | A date-time in ISO-8601 format | [optional] +**owner** | [**ActivityIdentity**](activity-identity) | | [optional] +**result** | **str** | The result of the approval | [optional] +**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval1 import Approval1 + +approval1 = Approval1( +comments=[ + sailpoint.v2024.models.approval_comment_2.ApprovalComment_2( + comment = 'This request was autoapproved by our automated ETS subscriber.', + commenter = 'Automated AR Approval', + date = '2018-06-25T20:22:28.104Z', ) + ], +modified='2018-06-25T20:22:28.104Z', +owner=, +result='Finished', +attribute_request=sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), +source= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalBatch.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalBatch.md new file mode 100644 index 000000000..4e68dff59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalBatch.md @@ -0,0 +1,36 @@ +--- +id: v2024-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalBatch', 'V2024ApprovalBatch'] +slug: /tools/sdk/python/v2024/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'V2024ApprovalBatch'] +--- + +# ApprovalBatch + +Batch properties if an approval is sent via batching. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_id** | **str** | ID of the batch | [optional] +**batch_size** | **int** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_batch import ApprovalBatch + +approval_batch = ApprovalBatch( +batch_id='38453251-6be2-5f8f-df93-5ce19e295837', +batch_size=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment.md new file mode 100644 index 000000000..f6ad2fc02 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment.md @@ -0,0 +1,41 @@ +--- +id: v2024-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalComment', 'V2024ApprovalComment'] +slug: /tools/sdk/python/v2024/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'V2024ApprovalComment'] +--- + +# ApprovalComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment provided either by the approval requester or the approver. | [required] +**timestamp** | **datetime** | The time when this comment was provided. | [required] +**user** | **str** | Name of the user that provided this comment. | [required] +**id** | **str** | Id of the user that provided this comment. | [required] +**changed_to_status** | **Enum** [ 'PENDING_APPROVAL', 'APPROVED', 'REJECTED' ] | Status transition of the draft. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.approval_comment import ApprovalComment + +approval_comment = ApprovalComment( +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/ApprovalComment1.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment1.md new file mode 100644 index 000000000..5d6174d21 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment1.md @@ -0,0 +1,41 @@ +--- +id: v2024-approval-comment1 +title: ApprovalComment1 +pagination_label: ApprovalComment1 +sidebar_label: ApprovalComment1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalComment1', 'V2024ApprovalComment1'] +slug: /tools/sdk/python/v2024/models/approval-comment1 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment1', 'V2024ApprovalComment1'] +--- + +# ApprovalComment1 + +Comments Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**author** | [**ApprovalIdentity**](approval-identity) | | [optional] +**comment** | **str** | Comment to be left on an approval | [optional] +**created_date** | **str** | Date the comment was created | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_comment1 import ApprovalComment1 + +approval_comment1 = ApprovalComment1( +author=sailpoint.v2024.models.approval_identity.ApprovalIdentity( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'IDENTITY', + name = 'John Doe', ), +comment='Looks good', +created_date='2023-04-12T23:20:50.52Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment2.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment2.md new file mode 100644 index 000000000..91e84abb6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalComment2.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-comment2 +title: ApprovalComment2 +pagination_label: ApprovalComment2 +sidebar_label: ApprovalComment2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalComment2', 'V2024ApprovalComment2'] +slug: /tools/sdk/python/v2024/models/approval-comment2 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment2', 'V2024ApprovalComment2'] +--- + +# ApprovalComment2 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | The comment text | [optional] +**commenter** | **str** | The name of the commenter | [optional] +**var_date** | **datetime** | A date-time in ISO-8601 format | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_comment2 import ApprovalComment2 + +approval_comment2 = ApprovalComment2( +comment='This request was autoapproved by our automated ETS subscriber.', +commenter='Automated AR Approval', +var_date='2018-06-25T20:22:28.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalDescription.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalDescription.md new file mode 100644 index 000000000..43ae85775 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalDescription.md @@ -0,0 +1,36 @@ +--- +id: v2024-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalDescription', 'V2024ApprovalDescription'] +slug: /tools/sdk/python/v2024/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'V2024ApprovalDescription'] +--- + +# ApprovalDescription + +The description of what the approval is asking for + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The description of what the approval is asking for | [optional] +**locale** | **str** | What locale the description of the approval is using | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_description import ApprovalDescription + +approval_description = ApprovalDescription( +value='This access allows viewing and editing of workflow resource', +locale='en_US' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalForwardHistory.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..159af6788 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalForwardHistory.md @@ -0,0 +1,43 @@ +--- +id: v2024-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalForwardHistory', 'V2024ApprovalForwardHistory'] +slug: /tools/sdk/python/v2024/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'V2024ApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**old_approver_name** | **str** | Display name of approver from whom the approval was forwarded. | [optional] +**new_approver_name** | **str** | Display name of approver to whom the approval was forwarded. | [optional] +**comment** | **str** | Comment made while forwarding. | [optional] +**modified** | **datetime** | Time at which approval was forwarded. | [optional] +**forwarder_name** | **str** | Display name of forwarder who forwarded the approval. | [optional] +**reassignment_type** | [**ReassignmentType**](reassignment-type) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_forward_history import ApprovalForwardHistory + +approval_forward_history = ApprovalForwardHistory( +old_approver_name='Frank Mir', +new_approver_name='Al Volta', +comment='Forwarding from Frank to Al', +modified='2019-08-23T18:52:57.398Z', +forwarder_name='William Wilson', +reassignment_type='AUTOMATIC_REASSIGNMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalIdentity.md new file mode 100644 index 000000000..36e70a50c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalIdentity', 'V2024ApprovalIdentity'] +slug: /tools/sdk/python/v2024/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'V2024ApprovalIdentity'] +--- + +# ApprovalIdentity + +Identity Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**type** | **Enum** [ 'IDENTITY' ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**name** | **str** | Name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_identity import ApprovalIdentity + +approval_identity = ApprovalIdentity( +id='85d173e7d57e496569df763231d6deb6a', +type='IDENTITY', +name='John Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalInfoResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..9ce1c2421 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalInfoResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse'] +slug: /tools/sdk/python/v2024/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse'] +--- + +# ApprovalInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of approver | [optional] +**name** | **str** | the name of approver | [optional] +**status** | **str** | the status of the approval request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_info_response import ApprovalInfoResponse + +approval_info_response = ApprovalInfoResponse( +id='8a80828f643d484f01643e14202e2000', +name='John Snow', +status='Approved' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalItemDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..63b46925e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalItemDetails.md @@ -0,0 +1,45 @@ +--- +id: v2024-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalItemDetails', 'V2024ApprovalItemDetails'] +slug: /tools/sdk/python/v2024/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'V2024ApprovalItemDetails'] +--- + +# ApprovalItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval item's ID | [optional] +**account** | **str** | The account referenced by the approval item | [optional] +**application** | **str** | The name of the application/source | [optional] +**name** | **str** | The attribute's name | [optional] +**operation** | **str** | The attribute's operation | [optional] +**value** | **str** | The attribute's value | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_item_details import ApprovalItemDetails + +approval_item_details = ApprovalItemDetails( +id='2c9180835d2e5168015d32f890ca1581', +account='john.smith', +application='Active Directory', +name='emailAddress', +operation='update', +value='a@b.com', +state= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalItems.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalItems.md new file mode 100644 index 000000000..246f02245 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalItems.md @@ -0,0 +1,45 @@ +--- +id: v2024-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalItems', 'V2024ApprovalItems'] +slug: /tools/sdk/python/v2024/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'V2024ApprovalItems'] +--- + +# ApprovalItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval item's ID | [optional] +**account** | **str** | The account referenced by the approval item | [optional] +**application** | **str** | The name of the application/source | [optional] +**name** | **str** | The attribute's name | [optional] +**operation** | **str** | The attribute's operation | [optional] +**value** | **str** | The attribute's value | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_items import ApprovalItems + +approval_items = ApprovalItems( +id='2c9180835d2e5168015d32f890ca1581', +account='john.smith', +application='Active Directory', +name='emailAddress', +operation='update', +value='a@b.com', +state= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalName.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalName.md new file mode 100644 index 000000000..3ad4a5573 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalName.md @@ -0,0 +1,36 @@ +--- +id: v2024-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalName', 'V2024ApprovalName'] +slug: /tools/sdk/python/v2024/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'V2024ApprovalName'] +--- + +# ApprovalName + +Approval Name Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Name of the approval | [optional] +**locale** | **str** | What locale the name of the approval is using | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_name import ApprovalName + +approval_name = ApprovalName( +value='Audit DB Access', +locale='en_US' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalReference.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalReference.md new file mode 100644 index 000000000..3e85f1128 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalReference.md @@ -0,0 +1,36 @@ +--- +id: v2024-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalReference', 'V2024ApprovalReference'] +slug: /tools/sdk/python/v2024/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'V2024ApprovalReference'] +--- + +# ApprovalReference + +Reference objects related to the approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the reference object | [optional] +**type** | **str** | What reference object does this ID correspond to | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_reference import ApprovalReference + +approval_reference = ApprovalReference( +id='64012350-8fd9-4f6c-a170-1fe123683899', +type='AccessRequestId' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..5734205e5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,43 @@ +--- +id: v2024-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalReminderAndEscalationConfig', 'V2024ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/python/v2024/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'V2024ApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days_until_escalation** | **int** | 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. | [optional] +**days_between_reminders** | **int** | Number of days to wait between reminder notifications. | [optional] +**max_reminders** | **int** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**fallback_approver_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_reminder_and_escalation_config import ApprovalReminderAndEscalationConfig + +approval_reminder_and_escalation_config = ApprovalReminderAndEscalationConfig( +days_until_escalation=0, +days_between_reminders=0, +max_reminders=1, +fallback_approver_ref=sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalScheme.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalScheme.md new file mode 100644 index 000000000..46bf83236 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalScheme.md @@ -0,0 +1,33 @@ +--- +id: v2024-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalScheme', 'V2024ApprovalScheme'] +slug: /tools/sdk/python/v2024/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'V2024ApprovalScheme'] +--- + +# ApprovalScheme + +Describes the individual or group that is responsible for an approval step. + +## Enum + +* `APP_OWNER` (value: `'APP_OWNER'`) + +* `SOURCE_OWNER` (value: `'SOURCE_OWNER'`) + +* `MANAGER` (value: `'MANAGER'`) + +* `ROLE_OWNER` (value: `'ROLE_OWNER'`) + +* `ACCESS_PROFILE_OWNER` (value: `'ACCESS_PROFILE_OWNER'`) + +* `ENTITLEMENT_OWNER` (value: `'ENTITLEMENT_OWNER'`) + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..466f5b3d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalSchemeForRole.md @@ -0,0 +1,35 @@ +--- +id: v2024-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalSchemeForRole', 'V2024ApprovalSchemeForRole'] +slug: /tools/sdk/python/v2024/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'V2024ApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | 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 | [optional] +**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_scheme_for_role import ApprovalSchemeForRole + +approval_scheme_for_role = ApprovalSchemeForRole( +approver_type='GOVERNANCE_GROUP', +approver_id='46c79819-a69f-49a2-becb-12c971ae66c6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatus.md new file mode 100644 index 000000000..b53f5ea7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: v2024-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatus', 'V2024ApprovalStatus'] +slug: /tools/sdk/python/v2024/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'V2024ApprovalStatus'] +--- + +# ApprovalStatus + +Enum representing the non-employee request approval status + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `PENDING` (value: `'PENDING'`) + +* `NOT_READY` (value: `'NOT_READY'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..0cd24c3ca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDto.md @@ -0,0 +1,57 @@ +--- +id: v2024-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDto', 'V2024ApprovalStatusDto'] +slug: /tools/sdk/python/v2024/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2024ApprovalStatusDto'] +--- + +# ApprovalStatusDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False] +**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**modified** | **datetime** | Time at which item was modified. | [optional] +**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**scheme** | [**ApprovalScheme**](approval-scheme) | | [optional] +**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**comment** | **str** | Comment, if any, provided by the approver. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_status_dto import ApprovalStatusDto + +approval_status_dto = ApprovalStatusDto( +forwarded=False, +original_owner=sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +current_owner=, +modified='2019-08-23T18:52:57.398Z', +status='PENDING', +scheme='MANAGER', +error_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.', ) + ], +comment='I approve this request', +remove_date='2020-07-11T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..cb9544a79 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'V2024ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/python/v2024/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'V2024ApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_status_dto_current_owner import ApprovalStatusDtoCurrentOwner + +approval_status_dto_current_owner = ApprovalStatusDtoCurrentOwner( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..eb510da76 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'V2024ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/python/v2024/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'V2024ApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +Identity of orginal approval owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original approval owner's identity. | [optional] +**id** | **str** | ID of original approval owner's identity. | [optional] +**name** | **str** | Display name of original approval owner. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_status_dto_original_owner import ApprovalStatusDtoOriginalOwner + +approval_status_dto_original_owner = ApprovalStatusDtoOriginalOwner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ApprovalSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalSummary.md new file mode 100644 index 000000000..bfdd6a280 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ApprovalSummary.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalSummary', 'V2024ApprovalSummary'] +slug: /tools/sdk/python/v2024/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'V2024ApprovalSummary'] +--- + +# ApprovalSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pending** | **int** | The number of pending access requests approvals. | [optional] +**approved** | **int** | The number of approved access requests approvals. | [optional] +**rejected** | **int** | The number of rejected access requests approvals. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.approval_summary import ApprovalSummary + +approval_summary = ApprovalSummary( +pending=0, +approved=0, +rejected=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Argument.md b/docs/tools/sdk/python/Reference/V2024/Models/Argument.md new file mode 100644 index 000000000..0deb3ee14 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Argument.md @@ -0,0 +1,37 @@ +--- +id: v2024-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Argument', 'V2024Argument'] +slug: /tools/sdk/python/v2024/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'V2024Argument'] +--- + +# Argument + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of the argument | [required] +**description** | **str** | the description of the argument | [optional] +**type** | **str** | the programmatic type of the argument | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.argument import Argument + +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/ArrayInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ArrayInner.md new file mode 100644 index 000000000..1959bd1fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ArrayInner.md @@ -0,0 +1,31 @@ +--- +id: v2024-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ArrayInner', 'V2024ArrayInner'] +slug: /tools/sdk/python/v2024/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'V2024ArrayInner'] +--- + +# ArrayInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.array_inner import ArrayInner + +array_inner = ArrayInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AssignmentContextDto.md b/docs/tools/sdk/python/Reference/V2024/Models/AssignmentContextDto.md new file mode 100644 index 000000000..73f413fda --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AssignmentContextDto.md @@ -0,0 +1,55 @@ +--- +id: v2024-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AssignmentContextDto', 'V2024AssignmentContextDto'] +slug: /tools/sdk/python/v2024/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'V2024AssignmentContextDto'] +--- + +# AssignmentContextDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested** | [**AccessRequestContext**](access-request-context) | | [optional] +**matched** | [**[]RoleMatchDto**](role-match-dto) | | [optional] +**computed_date** | **str** | Date that the assignment will was evaluated | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.assignment_context_dto import AssignmentContextDto + +assignment_context_dto = AssignmentContextDto( +requested=sailpoint.v2024.models.access_request_context.AccessRequestContext( + context_attributes = [ + sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ), +matched=[ + sailpoint.v2024.models.role_match_dto.RoleMatchDto( + role_ref = sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + matched_attributes = [ + sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ) + ], +computed_date='Wed Feb 14 10:58:42' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSource.md b/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSource.md new file mode 100644 index 000000000..876f37acc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttrSyncSource', 'V2024AttrSyncSource'] +slug: /tools/sdk/python/v2024/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'V2024AttrSyncSource'] +--- + +# AttrSyncSource + +Target source for attribute synchronization. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | DTO type of target source for attribute synchronization. | [optional] +**id** | **str** | ID of target source for attribute synchronization. | [optional] +**name** | **str** | Human-readable name of target source for attribute synchronization. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attr_sync_source import AttrSyncSource + +attr_sync_source = AttrSyncSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..52c1bc1b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,40 @@ +--- +id: v2024-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttrSyncSourceAttributeConfig', 'V2024AttrSyncSourceAttributeConfig'] +slug: /tools/sdk/python/v2024/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'V2024AttrSyncSourceAttributeConfig'] +--- + +# AttrSyncSourceAttributeConfig + +Specification of source attribute sync mapping configuration for an identity attribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the identity attribute | [required] +**display_name** | **str** | Display name of the identity attribute | [required] +**enabled** | **bool** | Determines whether or not the attribute is enabled for synchronization | [required] +**target** | **str** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [required] +} + +## Example + +```python +from sailpoint.v2024.models.attr_sync_source_attribute_config import AttrSyncSourceAttributeConfig + +attr_sync_source_attribute_config = AttrSyncSourceAttributeConfig( +name='email', +display_name='Email', +enabled=True, +target='mail' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..62d636aa8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttrSyncSourceConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttrSyncSourceConfig', 'V2024AttrSyncSourceConfig'] +slug: /tools/sdk/python/v2024/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'V2024AttrSyncSourceConfig'] +--- + +# AttrSyncSourceConfig + +Specification of attribute sync configuration for a source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**AttrSyncSource**](attr-sync-source) | | [required] +**attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | [required] +} + +## Example + +```python +from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig + +attr_sync_source_config = AttrSyncSourceConfig( +source=sailpoint.v2024.models.attr_sync_source.AttrSyncSource( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +attributes=[{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeChange.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeChange.md new file mode 100644 index 000000000..a04302c6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeChange.md @@ -0,0 +1,37 @@ +--- +id: v2024-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeChange', 'V2024AttributeChange'] +slug: /tools/sdk/python/v2024/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'V2024AttributeChange'] +--- + +# AttributeChange + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the attribute name | [optional] +**previous_value** | **str** | the old value of attribute | [optional] +**new_value** | **str** | the new value of attribute | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_change import AttributeChange + +attribute_change = AttributeChange( +name='', +previous_value='', +new_value='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDTO.md new file mode 100644 index 000000000..005bd0eb5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDTO.md @@ -0,0 +1,52 @@ +--- +id: v2024-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDTO', 'V2024AttributeDTO'] +slug: /tools/sdk/python/v2024/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'V2024AttributeDTO'] +--- + +# AttributeDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**name** | **str** | The display name of the key. | [optional] +**multiselect** | **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to False] +**status** | **str** | The status of the Attribute. | [optional] +**type** | **str** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**object_types** | **[]str** | 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. | [optional] +**description** | **str** | The description of the Attribute. | [optional] +**values** | [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_dto import AttributeDTO + +attribute_dto = AttributeDTO( +key='iscPrivacy', +name='Privacy', +multiselect=False, +status='active', +type='governance', +object_types=[entitlement], +description='Specifies the level of privacy associated with an access item.', +values=[ + sailpoint.v2024.models.attribute_value_dto.AttributeValueDTO( + value = 'public', + name = 'Public', + status = 'active', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDTOList.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDTOList.md new file mode 100644 index 000000000..ca5abcb37 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDTOList.md @@ -0,0 +1,33 @@ +--- +id: v2024-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDTOList', 'V2024AttributeDTOList'] +slug: /tools/sdk/python/v2024/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'V2024AttributeDTOList'] +--- + +# AttributeDTOList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_dto_list import AttributeDTOList + +attribute_dto_list = AttributeDTOList( +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}]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinition.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinition.md new file mode 100644 index 000000000..e44de1b27 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinition.md @@ -0,0 +1,48 @@ +--- +id: v2024-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinition', 'V2024AttributeDefinition'] +slug: /tools/sdk/python/v2024/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'V2024AttributeDefinition'] +--- + +# AttributeDefinition + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the attribute. | [optional] +**type** | [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**var_schema** | [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**description** | **str** | A human-readable description of the attribute. | [optional] +**is_multi** | **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to False] +**is_entitlement** | **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to False] +**is_group** | **bool** | 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.. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_definition import AttributeDefinition + +attribute_definition = AttributeDefinition( +name='sAMAccountName', +type='STRING', +var_schema=sailpoint.v2024.models.attribute_definition_schema.AttributeDefinition_schema( + type = 'CONNECTOR_SCHEMA', + id = '2c91808568c529c60168cca6f90c1313', + name = 'group', ), +description='SAM Account Name', +is_multi=False, +is_entitlement=False, +is_group=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..aad09c381 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionSchema.md @@ -0,0 +1,38 @@ +--- +id: v2024-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionSchema', 'V2024AttributeDefinitionSchema'] +slug: /tools/sdk/python/v2024/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'V2024AttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +A reference to the schema on the source to the attribute values map to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | The type of object being referenced | [optional] +**id** | **str** | The object ID this reference applies to. | [optional] +**name** | **str** | The human-readable display name of the object. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_definition_schema import AttributeDefinitionSchema + +attribute_definition_schema = AttributeDefinitionSchema( +type='CONNECTOR_SCHEMA', +id='2c91808568c529c60168cca6f90c1313', +name='group' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..0a3920531 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: v2024-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionType', 'V2024AttributeDefinitionType'] +slug: /tools/sdk/python/v2024/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2024AttributeDefinitionType'] +--- + +# AttributeDefinitionType + +The underlying type of the value which an AttributeDefinition represents. + +## Enum + +* `STRING` (value: `'STRING'`) + +* `LONG` (value: `'LONG'`) + +* `INT` (value: `'INT'`) + +* `BOOLEAN` (value: `'BOOLEAN'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeRequest.md new file mode 100644 index 000000000..ec70ebb04 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeRequest', 'V2024AttributeRequest'] +slug: /tools/sdk/python/v2024/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'V2024AttributeRequest'] +--- + +# AttributeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Attribute name. | [optional] +**op** | **str** | Operation to perform on attribute. | [optional] +**value** | [**AttributeRequestValue**](attribute-request-value) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_request import AttributeRequest + +attribute_request = AttributeRequest( +name='groups', +op='Add', +value= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeRequestValue.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeRequestValue.md new file mode 100644 index 000000000..4e2417a31 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeRequestValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-attribute-request-value +title: AttributeRequestValue +pagination_label: AttributeRequestValue +sidebar_label: AttributeRequestValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeRequestValue', 'V2024AttributeRequestValue'] +slug: /tools/sdk/python/v2024/models/attribute-request-value +tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'V2024AttributeRequestValue'] +--- + +# AttributeRequestValue + +Value of attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.attribute_request_value import AttributeRequestValue + +attribute_request_value = AttributeRequestValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeValueDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeValueDTO.md new file mode 100644 index 000000000..3dfc4ab70 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeValueDTO.md @@ -0,0 +1,37 @@ +--- +id: v2024-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeValueDTO', 'V2024AttributeValueDTO'] +slug: /tools/sdk/python/v2024/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'V2024AttributeValueDTO'] +--- + +# AttributeValueDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**name** | **str** | The display name of the Attribute value. | [optional] +**status** | **str** | The status of the Attribute value. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO + +attribute_value_dto = AttributeValueDTO( +value='public', +name='Public', +status='active' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributesChanged.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributesChanged.md new file mode 100644 index 000000000..8bc6fb4fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributesChanged.md @@ -0,0 +1,41 @@ +--- +id: v2024-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributesChanged', 'V2024AttributesChanged'] +slug: /tools/sdk/python/v2024/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2024AttributesChanged'] +--- + +# AttributesChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**changes** | [**[]AttributeChange**](attribute-change) | | [optional] +**event_type** | **str** | the event type | [optional] +**identity_id** | **str** | the identity id | [optional] +**dt** | **str** | the date of event | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.attributes_changed import AttributesChanged + +attributes_changed = AttributesChanged( +changes=[ + {name=firstname, previousValue=adam, newValue=zampa} + ], +event_type='', +identity_id='', +dt='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AuditDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/AuditDetails.md new file mode 100644 index 000000000..1ce74cb20 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AuditDetails.md @@ -0,0 +1,44 @@ +--- +id: v2024-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuditDetails', 'V2024AuditDetails'] +slug: /tools/sdk/python/v2024/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'V2024AuditDetails'] +--- + +# AuditDetails + +Audit details for the reassignment configuration of an identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | Initial date and time when the record was created | [optional] +**created_by** | [**Identity1**](identity1) | | [optional] +**modified** | **datetime** | Last modified date and time for the record | [optional] +**modified_by** | [**Identity1**](identity1) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.audit_details import AuditDetails + +audit_details = AuditDetails( +created='2022-07-21T11:13:12.345Z', +created_by=sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +modified='2022-07-21T11:13:12.345Z', +modified_by=sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AuthProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/AuthProfile.md new file mode 100644 index 000000000..00764a8ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AuthProfile.md @@ -0,0 +1,45 @@ +--- +id: v2024-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuthProfile', 'V2024AuthProfile'] +slug: /tools/sdk/python/v2024/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2024AuthProfile'] +--- + +# AuthProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Authentication Profile name. | [optional] +**off_network** | **bool** | Use it to block access from off network. | [optional] [default to False] +**untrusted_geography** | **bool** | Use it to block access from untrusted geoographies. | [optional] [default to False] +**application_id** | **str** | Application ID. | [optional] +**application_name** | **str** | Application name. | [optional] +**type** | **Enum** [ 'BLOCK', 'MFA', 'NON_PTA', 'PTA' ] | Type of the Authentication Profile. | [optional] +**strong_auth_login** | **bool** | Use it to enable strong authentication. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.auth_profile import AuthProfile + +auth_profile = AuthProfile( +name='EndToEnd-Profile', +off_network=True, +untrusted_geography=True, +application_id='2c91808458ae7a4f0158b1bbf8af0628', +application_name='EndToEnd-Source', +type='PTA', +strong_auth_login=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AuthProfileSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/AuthProfileSummary.md new file mode 100644 index 000000000..4ac6f53f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AuthProfileSummary.md @@ -0,0 +1,35 @@ +--- +id: v2024-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuthProfileSummary', 'V2024AuthProfileSummary'] +slug: /tools/sdk/python/v2024/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'V2024AuthProfileSummary'] +--- + +# AuthProfileSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenant** | **str** | Tenant name. | [optional] +**id** | **str** | Identity ID. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.auth_profile_summary import AuthProfileSummary + +auth_profile_summary = AuthProfileSummary( +tenant='test-tenant', +id='2c91808458ae7a4f0158b1bbf8af0628' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AuthUser.md b/docs/tools/sdk/python/Reference/V2024/Models/AuthUser.md new file mode 100644 index 000000000..84b30f2c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AuthUser.md @@ -0,0 +1,69 @@ +--- +id: v2024-auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuthUser', 'V2024AuthUser'] +slug: /tools/sdk/python/v2024/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'V2024AuthUser'] +--- + +# AuthUser + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenant** | **str** | Tenant name. | [optional] +**id** | **str** | Identity ID. | [optional] +**uid** | **str** | Identity's unique identitifier. | [optional] +**profile** | **str** | ID of the auth profile associated with the auth user. | [optional] +**identification_number** | **str** | Auth user's employee number. | [optional] +**email** | **str** | Auth user's email. | [optional] +**phone** | **str** | Auth user's phone number. | [optional] +**work_phone** | **str** | Auth user's work phone number. | [optional] +**personal_email** | **str** | Auth user's personal email. | [optional] +**firstname** | **str** | Auth user's first name. | [optional] +**lastname** | **str** | Auth user's last name. | [optional] +**display_name** | **str** | Auth user's name in displayed format. | [optional] +**alias** | **str** | Auth user's alias. | [optional] +**last_password_change_date** | **datetime** | Date of last password change. | [optional] +**last_login_timestamp** | **int** | Timestamp of the last login (long type value). | [optional] +**current_login_timestamp** | **int** | Timestamp of the current login (long type value). | [optional] +**last_unlock_timestamp** | **datetime** | The date and time when the user was last unlocked. | [optional] +**capabilities** | **[]str** | Array of the auth user's capabilities. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.auth_user import AuthUser + +auth_user = AuthUser( +tenant='test-tenant', +id='2c91808458ae7a4f0158b1bbf8af0628', +uid='will.smith', +profile='2c91808458ae7a4f0158b1bbf8af0756', +identification_number='19-5588452', +email='william.smith@example.com', +phone='5555555555', +work_phone='5555555555', +personal_email='william.smith@example.com', +firstname='Will', +lastname='Smith', +display_name='Will Smith', +alias='will.smith', +last_password_change_date='2021-03-08T22:37:33.901Z', +last_login_timestamp=1656327185832, +current_login_timestamp=1656327185832, +last_unlock_timestamp='2021-03-08T22:37:33.901Z', +capabilities=[ + 'ORG_ADMIN' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BackupOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/BackupOptions.md new file mode 100644 index 000000000..5df261048 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BackupOptions.md @@ -0,0 +1,38 @@ +--- +id: v2024-backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BackupOptions', 'V2024BackupOptions'] +slug: /tools/sdk/python/v2024/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'V2024BackupOptions'] +--- + +# BackupOptions + +Backup options control what will be included in the backup. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**include_types** | **[]str** | Object type names to be included in a Configuration Hub backup command. | [optional] +**object_options** | [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.backup_options import BackupOptions + +backup_options = BackupOptions( +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BackupResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/BackupResponse.md new file mode 100644 index 000000000..1bbf169b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BackupResponse.md @@ -0,0 +1,69 @@ +--- +id: v2024-backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BackupResponse', 'V2024BackupResponse'] +slug: /tools/sdk/python/v2024/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'V2024BackupResponse'] +--- + +# BackupResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this backup. | [optional] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the backup. | [optional] +**type** | **Enum** [ 'BACKUP' ] | Type of the job, will always be BACKUP for this type of job. | [optional] +**tenant** | **str** | The name of the tenant performing the upload | [optional] +**requester_name** | **str** | The name of the requester. | [optional] +**file_exists** | **bool** | Whether or not a file was created and stored for this backup. | [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** | The name assigned to the upload file in the request body. | [optional] +**user_can_delete** | **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to True] +**is_partial** | **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to False] +**backup_type** | **Enum** [ 'UPLOADED', 'AUTOMATED', 'MANUAL' ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**options** | [**BackupOptions**](backup-options) | | [optional] +**hydration_status** | **Enum** [ 'HYDRATED', 'NOT_HYDRATED' ] | Whether the object details of this backup are ready. | [optional] +**total_object_count** | **int** | Number of objects contained in this backup. | [optional] +**cloud_storage_status** | **Enum** [ 'SYNCED', 'NOT_SYNCED', 'SYNC_FAILED' ] | Whether this backup has been transferred to a customer storage location. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.backup_response import BackupResponse + +backup_response = BackupResponse( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='BACKUP', +tenant='tenant-name', +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='Backup Name', +user_can_delete=False, +is_partial=False, +backup_type='MANUAL', +options=sailpoint.v2024.models.backup_options.BackupOptions( + include_types = [ + 'TRIGGER_SUBSCRIPTION' + ], + object_options = {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}, ), +hydration_status='NOT_HYDRATED', +total_object_count=10, +cloud_storage_status='SYNCED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccess.md new file mode 100644 index 000000000..a17c1d621 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccess.md @@ -0,0 +1,51 @@ +--- +id: v2024-base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccess', 'V2024BaseAccess'] +slug: /tools/sdk/python/v2024/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2024BaseAccess'] +--- + +# BaseAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Access item's description. | [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] +**synced** | **datetime** | 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] +**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False] +**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True] +**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False] +**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.base_access import BaseAccess + +base_access = BaseAccess( +description='Admin access', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:33.104Z', +enabled=True, +requestable=True, +request_comments_required=False, +owner=sailpoint.v2024.models.base_access_owner.BaseAccess_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', + email = 'cloud-support@sailpoint.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseAccessOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccessOwner.md new file mode 100644 index 000000000..651f7787d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccessOwner.md @@ -0,0 +1,40 @@ +--- +id: v2024-base-access-owner +title: BaseAccessOwner +pagination_label: BaseAccessOwner +sidebar_label: BaseAccessOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccessOwner', 'V2024BaseAccessOwner'] +slug: /tools/sdk/python/v2024/models/base-access-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'V2024BaseAccessOwner'] +--- + +# BaseAccessOwner + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's display name. | [optional] +**email** | **str** | Owner's email. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.base_access_owner import BaseAccessOwner + +base_access_owner = BaseAccessOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support', +email='cloud-support@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseAccessProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccessProfile.md new file mode 100644 index 000000000..03b28b5b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccessProfile.md @@ -0,0 +1,35 @@ +--- +id: v2024-base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccessProfile', 'V2024BaseAccessProfile'] +slug: /tools/sdk/python/v2024/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'V2024BaseAccessProfile'] +--- + +# BaseAccessProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Access profile's unique ID. | [optional] +**name** | **str** | Access profile's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.base_access_profile import BaseAccessProfile + +base_access_profile = BaseAccessProfile( +id='2c91809c6faade77016fb4f0b63407ae', +name='Admin Access' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccount.md new file mode 100644 index 000000000..c50866211 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseAccount.md @@ -0,0 +1,57 @@ +--- +id: v2024-base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccount', 'V2024BaseAccount'] +slug: /tools/sdk/python/v2024/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'V2024BaseAccount'] +--- + +# BaseAccount + + +## 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] +**account_id** | **str** | Account ID. | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +**disabled** | **bool** | Indicates whether the account is disabled. | [optional] [default to False] +**locked** | **bool** | Indicates whether the account is locked. | [optional] [default to False] +**privileged** | **bool** | Indicates whether the account is privileged. | [optional] [default to False] +**manually_correlated** | **bool** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to False] +**password_last_set** | **datetime** | A date-time in ISO-8601 format | [optional] +**entitlement_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**supports_password_change** | **bool** | Indicates whether the account supports password change. | [optional] [default to False] +**account_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.base_account import BaseAccount + +base_account = BaseAccount( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +account_id='John.Doe', +source=, +disabled=False, +locked=False, +privileged=False, +manually_correlated=False, +password_last_set='2018-06-25T20:22:28.104Z', +entitlement_attributes={moderator=true, admin=true, trust_level=4}, +created='2018-06-25T20:22:28.104Z', +supports_password_change=False, +account_attributes={type=global, admin=true, trust_level=4} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseCommonDto.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseCommonDto.md new file mode 100644 index 000000000..06a39ba7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseCommonDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseCommonDto', 'V2024BaseCommonDto'] +slug: /tools/sdk/python/v2024/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'V2024BaseCommonDto'] +--- + +# BaseCommonDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.base_common_dto import BaseCommonDto + +base_common_dto = BaseCommonDto( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseDocument.md new file mode 100644 index 000000000..ebbe2c74e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseDocument.md @@ -0,0 +1,35 @@ +--- +id: v2024-base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseDocument', 'V2024BaseDocument'] +slug: /tools/sdk/python/v2024/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2024BaseDocument'] +--- + +# BaseDocument + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the referenced object. | [required] +**name** | **str** | The human readable name of the referenced object. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.base_document import BaseDocument + +base_document = BaseDocument( +id='2c91808375d8e80a0175e1f88a575222', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseEntitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseEntitlement.md new file mode 100644 index 000000000..5064b8e9b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseEntitlement.md @@ -0,0 +1,47 @@ +--- +id: v2024-base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseEntitlement', 'V2024BaseEntitlement'] +slug: /tools/sdk/python/v2024/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'V2024BaseEntitlement'] +--- + +# BaseEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False] +**description** | **str** | Entitlement's description. | [optional] +**attribute** | **str** | Entitlement attribute's name. | [optional] +**value** | **str** | Entitlement's value. | [optional] +**var_schema** | **str** | Entitlement's schema. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.base_entitlement import BaseEntitlement + +base_entitlement = BaseEntitlement( +has_permissions=False, +description='Cloud engineering', +attribute='memberOf', +value='CN=Cloud Engineering,DC=sailpoint,DC=COM', +var_schema='group', +privileged=False, +id='2c918084575812550157589064f33b89', +name='CN=Cloud Engineering,DC=sailpoint,DC=COM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseReferenceDto.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseReferenceDto.md new file mode 100644 index 000000000..ae9921d25 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseReferenceDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto', 'V2024BaseReferenceDto'] +slug: /tools/sdk/python/v2024/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'V2024BaseReferenceDto'] +--- + +# BaseReferenceDto + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.base_reference_dto import BaseReferenceDto + +base_reference_dto = BaseReferenceDto( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BaseSegment.md b/docs/tools/sdk/python/Reference/V2024/Models/BaseSegment.md new file mode 100644 index 000000000..a7dd8591e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BaseSegment.md @@ -0,0 +1,35 @@ +--- +id: v2024-base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseSegment', 'V2024BaseSegment'] +slug: /tools/sdk/python/v2024/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'V2024BaseSegment'] +--- + +# BaseSegment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Segment's unique ID. | [optional] +**name** | **str** | Segment's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.base_segment import BaseSegment + +base_segment = BaseSegment( +id='b009b6e3-b56d-41d9-8735-cb532ea0b017', +name='Test Segment' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BasicAuthConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/BasicAuthConfig.md new file mode 100644 index 000000000..cbd8f1431 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BasicAuthConfig.md @@ -0,0 +1,36 @@ +--- +id: v2024-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BasicAuthConfig', 'V2024BasicAuthConfig'] +slug: /tools/sdk/python/v2024/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'V2024BasicAuthConfig'] +--- + +# BasicAuthConfig + +Config required if BASIC_AUTH is used. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | The username to authenticate. | [optional] +**password** | **str** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.basic_auth_config import BasicAuthConfig + +basic_auth_config = BasicAuthConfig( +user_name='user@example.com', +password='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..9a47af3ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BearerTokenAuthConfig.md @@ -0,0 +1,34 @@ +--- +id: v2024-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BearerTokenAuthConfig', 'V2024BearerTokenAuthConfig'] +slug: /tools/sdk/python/v2024/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'V2024BearerTokenAuthConfig'] +--- + +# BearerTokenAuthConfig + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bearer_token** | **str** | Bearer token | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.bearer_token_auth_config import BearerTokenAuthConfig + +bearer_token_auth_config = BearerTokenAuthConfig( +bearer_token='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/python/Reference/V2024/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..44f1bb657 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BeforeProvisioningRuleDto', 'V2024BeforeProvisioningRuleDto'] +slug: /tools/sdk/python/v2024/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'V2024BeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +Before Provisioning Rule. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Before Provisioning Rule DTO type. | [optional] +**id** | **str** | Before Provisioning Rule ID. | [optional] +**name** | **str** | Rule display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.before_provisioning_rule_dto import BeforeProvisioningRuleDto + +before_provisioning_rule_dto = BeforeProvisioningRuleDto( +type='RULE', +id='048eb3d55c5a4758bd07dccb87741c78', +name='Before Provisioning Airtable Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Bound.md b/docs/tools/sdk/python/Reference/V2024/Models/Bound.md new file mode 100644 index 000000000..863a09c6d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Bound.md @@ -0,0 +1,35 @@ +--- +id: v2024-bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Bound', 'V2024Bound'] +slug: /tools/sdk/python/v2024/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'V2024Bound'] +--- + +# Bound + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The value of the range's endpoint. | [required] +**inclusive** | **bool** | Indicates if the endpoint is included in the range. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.bound import Bound + +bound = Bound( +value='1', +inclusive=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BrandingItem.md b/docs/tools/sdk/python/Reference/V2024/Models/BrandingItem.md new file mode 100644 index 000000000..a1f01ffdd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BrandingItem.md @@ -0,0 +1,47 @@ +--- +id: v2024-branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BrandingItem', 'V2024BrandingItem'] +slug: /tools/sdk/python/v2024/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'V2024BrandingItem'] +--- + +# BrandingItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | name of branding item | [optional] +**product_name** | **str** | product name | [optional] +**action_button_color** | **str** | hex value of color for action button | [optional] +**active_link_color** | **str** | hex value of color for link | [optional] +**navigation_color** | **str** | hex value of color for navigation bar | [optional] +**email_from_address** | **str** | email from address | [optional] +**standard_logo_url** | **str** | url to standard logo | [optional] +**login_informational_message** | **str** | login information message | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.branding_item import BrandingItem + +branding_item = BrandingItem( +name='default', +product_name='product name', +action_button_color='0074D9', +active_link_color='011E69', +navigation_color='011E69', +email_from_address='no-reply@sailpoint.com', +standard_logo_url='', +login_informational_message='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BrandingItemCreate.md b/docs/tools/sdk/python/Reference/V2024/Models/BrandingItemCreate.md new file mode 100644 index 000000000..72ba16630 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BrandingItemCreate.md @@ -0,0 +1,47 @@ +--- +id: v2024-branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BrandingItemCreate', 'V2024BrandingItemCreate'] +slug: /tools/sdk/python/v2024/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'V2024BrandingItemCreate'] +--- + +# BrandingItemCreate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | name of branding item | [required] +**product_name** | **str** | product name | [required] +**action_button_color** | **str** | hex value of color for action button | [optional] +**active_link_color** | **str** | hex value of color for link | [optional] +**navigation_color** | **str** | hex value of color for navigation bar | [optional] +**email_from_address** | **str** | email from address | [optional] +**login_informational_message** | **str** | login information message | [optional] +**file_standard** | **bytearray** | png file with logo | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.branding_item_create import BrandingItemCreate + +branding_item_create = BrandingItemCreate( +name='custom-branding-item', +product_name='product name', +action_button_color='0074D9', +active_link_color='011E69', +navigation_color='011E69', +email_from_address='no-reply@sailpoint.com', +login_informational_message='', +file_standard='\x00\x00\x00\x02' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BucketAggregation.md b/docs/tools/sdk/python/Reference/V2024/Models/BucketAggregation.md new file mode 100644 index 000000000..a4480f8a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BucketAggregation.md @@ -0,0 +1,42 @@ +--- +id: v2024-bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BucketAggregation', 'V2024BucketAggregation'] +slug: /tools/sdk/python/v2024/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'V2024BucketAggregation'] +--- + +# BucketAggregation + +The bucket to group the results of the aggregation query by. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the bucket aggregate to be included in the result. | [required] +**type** | [**BucketType**](bucket-type) | | [optional] [default to BucketType.TERMS] +**var_field** | **str** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required] +**size** | **int** | Maximum number of buckets to include. | [optional] +**min_doc_count** | **int** | Minimum number of documents a bucket should have. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.bucket_aggregation import BucketAggregation + +bucket_aggregation = BucketAggregation( +name='Identity Locations', +type='TERMS', +var_field='attributes.city', +size=100, +min_doc_count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BucketType.md b/docs/tools/sdk/python/Reference/V2024/Models/BucketType.md new file mode 100644 index 000000000..f79c8d17c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BucketType.md @@ -0,0 +1,21 @@ +--- +id: v2024-bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BucketType', 'V2024BucketType'] +slug: /tools/sdk/python/v2024/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'V2024BucketType'] +--- + +# BucketType + +Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. + +## Enum + +* `TERMS` (value: `'TERMS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BulkAddTaggedObject.md b/docs/tools/sdk/python/Reference/V2024/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..59beb6d52 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BulkAddTaggedObject.md @@ -0,0 +1,42 @@ +--- +id: v2024-bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkAddTaggedObject', 'V2024BulkAddTaggedObject'] +slug: /tools/sdk/python/v2024/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'V2024BulkAddTaggedObject'] +--- + +# BulkAddTaggedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to an Object | [optional] +**operation** | **Enum** [ 'APPEND', 'MERGE' ] | 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. | [optional] [default to 'APPEND'] +} + +## Example + +```python +from sailpoint.v2024.models.bulk_add_tagged_object import BulkAddTaggedObject + +bulk_add_tagged_object = BulkAddTaggedObject( +object_refs=[ + sailpoint.v2024.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI], +operation='APPEND' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BulkApproveAccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/BulkApproveAccessRequest.md new file mode 100644 index 000000000..6899c9de0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BulkApproveAccessRequest.md @@ -0,0 +1,36 @@ +--- +id: v2024-bulk-approve-access-request +title: BulkApproveAccessRequest +pagination_label: BulkApproveAccessRequest +sidebar_label: BulkApproveAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkApproveAccessRequest', 'V2024BulkApproveAccessRequest'] +slug: /tools/sdk/python/v2024/models/bulk-approve-access-request +tags: ['SDK', 'Software Development Kit', 'BulkApproveAccessRequest', 'V2024BulkApproveAccessRequest'] +--- + +# BulkApproveAccessRequest + +Request body payload for bulk approve access request endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_ids** | **[]str** | List of approval ids to approve the pending requests | [required] +**comment** | **str** | Reason for approving the pending access request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.bulk_approve_access_request import BulkApproveAccessRequest + +bulk_approve_access_request = BulkApproveAccessRequest( +approval_ids=[2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582], +comment='I approve these request items' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BulkCancelAccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/BulkCancelAccessRequest.md new file mode 100644 index 000000000..370f77717 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BulkCancelAccessRequest.md @@ -0,0 +1,36 @@ +--- +id: v2024-bulk-cancel-access-request +title: BulkCancelAccessRequest +pagination_label: BulkCancelAccessRequest +sidebar_label: BulkCancelAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkCancelAccessRequest', 'V2024BulkCancelAccessRequest'] +slug: /tools/sdk/python/v2024/models/bulk-cancel-access-request +tags: ['SDK', 'Software Development Kit', 'BulkCancelAccessRequest', 'V2024BulkCancelAccessRequest'] +--- + +# BulkCancelAccessRequest + +Request body payload for bulk cancel access request endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_ids** | **[]str** | List of access requests ids to cancel the pending requests | [required] +**comment** | **str** | Reason for cancelling the pending access request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.bulk_cancel_access_request import BulkCancelAccessRequest + +bulk_cancel_access_request = BulkCancelAccessRequest( +access_request_ids=[2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582], +comment='I requested this role by mistake.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..749cd5aab --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,38 @@ +--- +id: v2024-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkIdentitiesAccountsResponse', 'V2024BulkIdentitiesAccountsResponse'] +slug: /tools/sdk/python/v2024/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'V2024BulkIdentitiesAccountsResponse'] +--- + +# BulkIdentitiesAccountsResponse + +Bulk response object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of bulk request item. | [optional] +**status_code** | **int** | Response status value. | [optional] +**message** | **str** | Status containing additional context information about failures. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse + +bulk_identities_accounts_response = BulkIdentitiesAccountsResponse( +id='2c9180858082150f0180893dbaf553fe', +status_code=404, +message='Referenced identity "2c9180858082150f0180893dbaf553fe" was not found.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/python/Reference/V2024/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..e34c965df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,40 @@ +--- +id: v2024-bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkRemoveTaggedObject', 'V2024BulkRemoveTaggedObject'] +slug: /tools/sdk/python/v2024/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'V2024BulkRemoveTaggedObject'] +--- + +# BulkRemoveTaggedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.bulk_remove_tagged_object import BulkRemoveTaggedObject + +bulk_remove_tagged_object = BulkRemoveTaggedObject( +object_refs=[ + sailpoint.v2024.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..5f53720d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,40 @@ +--- +id: v2024-bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkTaggedObjectResponse', 'V2024BulkTaggedObjectResponse'] +slug: /tools/sdk/python/v2024/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'V2024BulkTaggedObjectResponse'] +--- + +# BulkTaggedObjectResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.bulk_tagged_object_response import BulkTaggedObjectResponse + +bulk_tagged_object_response = BulkTaggedObjectResponse( +object_refs=[ + sailpoint.v2024.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Campaign.md b/docs/tools/sdk/python/Reference/V2024/Models/Campaign.md new file mode 100644 index 000000000..b01103377 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Campaign.md @@ -0,0 +1,123 @@ +--- +id: v2024-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Campaign', 'V2024Campaign'] +slug: /tools/sdk/python/v2024/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'V2024Campaign'] +--- + +# Campaign + + +## 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.campaign import Campaign + +campaign = Campaign( +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/CampaignActivated.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivated.md new file mode 100644 index 000000000..6c05e3544 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivated.md @@ -0,0 +1,45 @@ +--- +id: v2024-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignActivated', 'V2024CampaignActivated'] +slug: /tools/sdk/python/v2024/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'V2024CampaignActivated'] +--- + +# CampaignActivated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_activated import CampaignActivated + +campaign_activated = CampaignActivated( +campaign=sailpoint.v2024.models.campaign_activated_campaign.CampaignActivated_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-02-16T03:06:45.815Z', + deadline = '2021-03-16T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.v2024.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = ACTIVE, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..6f79831d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivatedCampaign.md @@ -0,0 +1,53 @@ +--- +id: v2024-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignActivatedCampaign', 'V2024CampaignActivatedCampaign'] +slug: /tools/sdk/python/v2024/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'V2024CampaignActivatedCampaign'] +--- + +# CampaignActivatedCampaign + +Details about the certification campaign that was activated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID for the campaign. | [required] +**name** | **str** | The human friendly name of the campaign. | [required] +**description** | **str** | Extended description of the campaign. | [required] +**created** | **datetime** | The date and time the campaign was created. | [required] +**modified** | **datetime** | The date and time the campaign was last modified. | [optional] +**deadline** | **datetime** | The date and time the campaign is due. | [required] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign. | [required] +**campaign_owner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**status** | **Enum** [ 'ACTIVE' ] | The current status of the campaign. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_activated_campaign import CampaignActivatedCampaign + +campaign_activated_campaign = CampaignActivatedCampaign( +id='2c91808576f886190176f88cac5a0010', +name='Manager Access Campaign', +description='Audit access for all employees.', +created='2021-02-16T03:04:45.815Z', +modified='2021-02-16T03:06:45.815Z', +deadline='2021-03-16T03:04:45.815Z', +type=MANAGER, +campaign_owner=sailpoint.v2024.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), +status=ACTIVE +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..f6d674c40 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'V2024CampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/python/v2024/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'V2024CampaignActivatedCampaignCampaignOwner'] +--- + +# CampaignActivatedCampaignCampaignOwner + +Details of the identity that owns the campaign. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity. | [required] +**display_name** | **str** | The human friendly name of the identity. | [required] +**email** | **str** | The primary email address of the identity. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_activated_campaign_campaign_owner import CampaignActivatedCampaignCampaignOwner + +campaign_activated_campaign_campaign_owner = CampaignActivatedCampaignCampaignOwner( +id='37f080867702c1910177031320c40n27', +display_name='John Snow', +email='john.snow@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAlert.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAlert.md new file mode 100644 index 000000000..54302ce7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAlert.md @@ -0,0 +1,40 @@ +--- +id: v2024-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAlert', 'V2024CampaignAlert'] +slug: /tools/sdk/python/v2024/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'V2024CampaignAlert'] +--- + +# CampaignAlert + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**level** | **Enum** [ 'ERROR', 'WARN', 'INFO' ] | Denotes the level of the message | [optional] +**localizations** | [**[]ErrorMessageDto**](error-message-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_alert import CampaignAlert + +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.', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfFilter.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..47cc66e8c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfFilter.md @@ -0,0 +1,38 @@ +--- +id: v2024-campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfFilter', 'V2024CampaignAllOfFilter'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'V2024CampaignAllOfFilter'] +--- + +# CampaignAllOfFilter + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of whatever type of filter is being used. | [optional] +**type** | **Enum** [ 'CAMPAIGN_FILTER', 'RULE' ] | Type of the filter | [optional] +**name** | **str** | Name of the filter | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_filter import CampaignAllOfFilter + +campaign_all_of_filter = CampaignAllOfFilter( +id='0fbe863c063c4c88a35fd7f17e8a3df5', +type='CAMPAIGN_FILTER', +name='Test Filter' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..775e3a814 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,36 @@ +--- +id: v2024-campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'V2024CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'V2024CampaignAllOfMachineAccountCampaignInfo'] +--- + +# CampaignAllOfMachineAccountCampaignInfo + +Must be set only if the campaign type is MACHINE_ACCOUNT. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_ids** | **[]str** | The list of sources to be included in the campaign. | [optional] +**reviewer_type** | **Enum** [ 'ACCOUNT_OWNER' ] | The reviewer's type. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_machine_account_campaign_info import CampaignAllOfMachineAccountCampaignInfo + +campaign_all_of_machine_account_campaign_info = CampaignAllOfMachineAccountCampaignInfo( +source_ids=[0fbe863c063c4c88a35fd7f17e8a3df5], +reviewer_type='ACCOUNT_OWNER' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..b20075e37 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,50 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2024CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2024CampaignAllOfRoleCompositionCampaignInfo'] +--- + +# CampaignAllOfRoleCompositionCampaignInfo + +Optional configuration options for role composition campaigns. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reviewer_id** | **str** | The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. | [optional] +**reviewer** | [**CampaignAllOfRoleCompositionCampaignInfoReviewer**](campaign-all-of-role-composition-campaign-info-reviewer) | | [optional] +**role_ids** | **[]str** | 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. | [optional] +**remediator_ref** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] +**query** | **str** | 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. | [optional] +**description** | **str** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info import CampaignAllOfRoleCompositionCampaignInfo + +campaign_all_of_role_composition_campaign_info = CampaignAllOfRoleCompositionCampaignInfo( +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..dc19bbe00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,38 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Legal Remediator Type | [required] +**id** | **str** | The ID of the remediator. | [required] +**name** | **str** | The name of the remediator. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_remediator_ref import CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +campaign_all_of_role_composition_campaign_info_remediator_ref = CampaignAllOfRoleCompositionCampaignInfoRemediatorRef( +type='IDENTITY', +id='2c90ad2a70ace7d50170acf22ca90010', +name='Role Admin' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md new file mode 100644 index 000000000..116f38812 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md @@ -0,0 +1,38 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info-reviewer +title: CampaignAllOfRoleCompositionCampaignInfoReviewer +pagination_label: CampaignAllOfRoleCompositionCampaignInfoReviewer +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoReviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-role-composition-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoReviewer + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | The reviewer's DTO type. | [optional] +**id** | **str** | The reviewer's ID. | [optional] +**name** | **str** | The reviewer's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer import CampaignAllOfRoleCompositionCampaignInfoReviewer + +campaign_all_of_role_composition_campaign_info_reviewer = CampaignAllOfRoleCompositionCampaignInfoReviewer( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..3026eaedf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,52 @@ +--- +id: v2024-campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'V2024CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'V2024CampaignAllOfSearchCampaignInfo'] +--- + +# CampaignAllOfSearchCampaignInfo + +Must be set only if the campaign type is SEARCH. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'ACCESS' ] | The type of search campaign represented. | [required] +**description** | **str** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**reviewer** | [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**query** | **str** | 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. | [optional] +**identity_ids** | **[]str** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**access_constraints** | [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_search_campaign_info import CampaignAllOfSearchCampaignInfo + +campaign_all_of_search_campaign_info = CampaignAllOfSearchCampaignInfo( +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', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..cf96ec5ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,38 @@ +--- +id: v2024-campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2024CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2024CampaignAllOfSearchCampaignInfoReviewer'] +--- + +# CampaignAllOfSearchCampaignInfoReviewer + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | The reviewer's DTO type. | [optional] +**id** | **str** | The reviewer's ID. | [optional] +**name** | **str** | The reviewer's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer import CampaignAllOfSearchCampaignInfoReviewer + +campaign_all_of_search_campaign_info_reviewer = CampaignAllOfSearchCampaignInfoReviewer( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..da675e2bc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,34 @@ +--- +id: v2024-campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2024CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2024CampaignAllOfSourceOwnerCampaignInfo'] +--- + +# CampaignAllOfSourceOwnerCampaignInfo + +Must be set only if the campaign type is SOURCE_OWNER. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_ids** | **[]str** | The list of sources to be included in the campaign. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_source_owner_campaign_info import CampaignAllOfSourceOwnerCampaignInfo + +campaign_all_of_source_owner_campaign_info = CampaignAllOfSourceOwnerCampaignInfo( +source_ids=[0fbe863c063c4c88a35fd7f17e8a3df5] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..018e4c3b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,37 @@ +--- +id: v2024-campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2024CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/python/v2024/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2024CampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# CampaignAllOfSourcesWithOrphanEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the source | [optional] +**type** | **Enum** [ 'SOURCE' ] | Type | [optional] +**name** | **str** | Name of the source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_all_of_sources_with_orphan_entitlements import CampaignAllOfSourcesWithOrphanEntitlements + +campaign_all_of_sources_with_orphan_entitlements = CampaignAllOfSourcesWithOrphanEntitlements( +id='2c90ad2a70ace7d50170acf22ca90010', +type='SOURCE', +name='Source with orphan entitlements' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignCompleteOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..001280d46 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignCompleteOptions.md @@ -0,0 +1,33 @@ +--- +id: v2024-campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignCompleteOptions', 'V2024CampaignCompleteOptions'] +slug: /tools/sdk/python/v2024/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'V2024CampaignCompleteOptions'] +--- + +# CampaignCompleteOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto_complete_action** | **Enum** [ 'APPROVE', 'REVOKE' ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to 'APPROVE'] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_complete_options import CampaignCompleteOptions + +campaign_complete_options = CampaignCompleteOptions( +auto_complete_action='APPROVE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignEnded.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignEnded.md new file mode 100644 index 000000000..22fb48487 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignEnded.md @@ -0,0 +1,45 @@ +--- +id: v2024-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignEnded', 'V2024CampaignEnded'] +slug: /tools/sdk/python/v2024/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'V2024CampaignEnded'] +--- + +# CampaignEnded + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_ended import CampaignEnded + +campaign_ended = CampaignEnded( +campaign=sailpoint.v2024.models.campaign_ended_campaign.CampaignEnded_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-03-16T03:06:45.815Z', + deadline = '2021-03-16T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.v2024.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = COMPLETED, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignEndedCampaign.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..301cf544a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignEndedCampaign.md @@ -0,0 +1,53 @@ +--- +id: v2024-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignEndedCampaign', 'V2024CampaignEndedCampaign'] +slug: /tools/sdk/python/v2024/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'V2024CampaignEndedCampaign'] +--- + +# CampaignEndedCampaign + +Details about the certification campaign that ended. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID for the campaign. | [required] +**name** | **str** | The human friendly name of the campaign. | [required] +**description** | **str** | Extended description of the campaign. | [required] +**created** | **datetime** | The date and time the campaign was created. | [required] +**modified** | **datetime** | The date and time the campaign was last modified. | [optional] +**deadline** | **datetime** | The date and time the campaign is due. | [required] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign. | [required] +**campaign_owner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**status** | **Enum** [ 'COMPLETED' ] | The current status of the campaign. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_ended_campaign import CampaignEndedCampaign + +campaign_ended_campaign = CampaignEndedCampaign( +id='2c91808576f886190176f88cac5a0010', +name='Manager Access Campaign', +description='Audit access for all employees.', +created='2021-02-16T03:04:45.815Z', +modified='2021-03-16T03:06:45.815Z', +deadline='2021-03-16T03:04:45.815Z', +type=MANAGER, +campaign_owner=sailpoint.v2024.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), +status=COMPLETED +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignFilterDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..3fa3bf578 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignFilterDetails.md @@ -0,0 +1,46 @@ +--- +id: v2024-campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignFilterDetails', 'V2024CampaignFilterDetails'] +slug: /tools/sdk/python/v2024/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'V2024CampaignFilterDetails'] +--- + +# CampaignFilterDetails + +Campaign Filter Details + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign filter | [required] +**name** | **str** | Campaign filter name. | [required] +**description** | **str** | Campaign filter description. | [optional] +**owner** | **str** | Owner of the filter. This field automatically populates at creation time with the current user. | [required] +**mode** | **Enum** [ 'INCLUSION', 'EXCLUSION' ] | 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. | [required] +**criteria_list** | [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**is_system_filter** | **bool** | If true, the filter is created by the system. If false, the filter is created by a user. | [required][default to False] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails + +campaign_filter_details = CampaignFilterDetails( +id='5ec18cef39020d6fd7a60ad3970aba61', +name='Identity Attribute Campaign Filter', +description='Campaign filter to certify data based on an identity attribute's specified property.', +owner='SailPoint Support', +mode=INCLUSION, +criteria_list=[{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}], +is_system_filter=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..fe1d895ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'V2024CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/python/v2024/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'V2024CampaignFilterDetailsCriteriaListInner'] +--- + +# CampaignFilterDetailsCriteriaListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**CriteriaType**](criteria-type) | | [required] +**operation** | [**Operation**](operation) | | [required] +**var_property** | **str** | Specified key from the type of criteria. | [required] +**value** | **str** | Value for the specified key from the type of criteria. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_filter_details_criteria_list_inner import CampaignFilterDetailsCriteriaListInner + +campaign_filter_details_criteria_list_inner = CampaignFilterDetailsCriteriaListInner( +type='IDENTITY_ATTRIBUTE', +operation=, +var_property='displayName', +value='Allie' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignGenerated.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignGenerated.md new file mode 100644 index 000000000..830725931 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignGenerated.md @@ -0,0 +1,45 @@ +--- +id: v2024-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignGenerated', 'V2024CampaignGenerated'] +slug: /tools/sdk/python/v2024/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'V2024CampaignGenerated'] +--- + +# CampaignGenerated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_generated import CampaignGenerated + +campaign_generated = CampaignGenerated( +campaign=sailpoint.v2024.models.campaign_generated_campaign.CampaignGenerated_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-02-17T03:04:45.815Z', + deadline = '2021-02-18T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.v2024.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = STAGED, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..dcd106640 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,53 @@ +--- +id: v2024-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignGeneratedCampaign', 'V2024CampaignGeneratedCampaign'] +slug: /tools/sdk/python/v2024/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'V2024CampaignGeneratedCampaign'] +--- + +# CampaignGeneratedCampaign + +Details about the campaign that was generated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign. | [required] +**name** | **str** | Human friendly name of the campaign. | [required] +**description** | **str** | Extended description of the campaign. | [required] +**created** | **datetime** | The date and time the campaign was created. | [required] +**modified** | **str** | The date and time the campaign was last modified. | [optional] +**deadline** | **str** | The date and time when the campaign must be finished by. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign that was generated. | [required] +**campaign_owner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required] +**status** | **Enum** [ 'STAGED', 'ACTIVATING', 'ACTIVE' ] | The current status of the campaign. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_generated_campaign import CampaignGeneratedCampaign + +campaign_generated_campaign = CampaignGeneratedCampaign( +id='2c91808576f886190176f88cac5a0010', +name='Manager Access Campaign', +description='Audit access for all employees.', +created='2021-02-16T03:04:45.815Z', +modified='2021-02-17T03:04:45.815Z', +deadline='2021-02-18T03:04:45.815Z', +type=MANAGER, +campaign_owner=sailpoint.v2024.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), +status=STAGED +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..92d8ef1bf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'V2024CampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/python/v2024/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'V2024CampaignGeneratedCampaignCampaignOwner'] +--- + +# CampaignGeneratedCampaignCampaignOwner + +The identity that owns the campaign. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity. | [required] +**display_name** | **str** | The display name of the identity. | [required] +**email** | **str** | The primary email address of the identity. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_generated_campaign_campaign_owner import CampaignGeneratedCampaignCampaignOwner + +campaign_generated_campaign_campaign_owner = CampaignGeneratedCampaignCampaignOwner( +id='37f080867702c1910177031320c40n27', +display_name='John Snow', +email='john.snow@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignReference.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignReference.md new file mode 100644 index 000000000..6a28ced1e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignReference.md @@ -0,0 +1,45 @@ +--- +id: v2024-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReference', 'V2024CampaignReference'] +slug: /tools/sdk/python/v2024/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'V2024CampaignReference'] +--- + +# CampaignReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign. | [required] +**name** | **str** | The name of the campaign. | [required] +**type** | **Enum** [ 'CAMPAIGN' ] | The type of object that is being referenced. | [required] +**campaign_type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH' ] | The type of the campaign. | [required] +**description** | **str** | The description of the campaign set by the admin who created it. | [required] +**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). | [required] +**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. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_reference import CampaignReference + +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignReport.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignReport.md new file mode 100644 index 000000000..280cbfe46 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignReport.md @@ -0,0 +1,43 @@ +--- +id: v2024-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReport', 'V2024CampaignReport'] +slug: /tools/sdk/python/v2024/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'V2024CampaignReport'] +--- + +# CampaignReport + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +**status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR', 'PENDING' ] | Status of a SOD policy violation report. | [optional] +**report_type** | [**ReportType**](report-type) | | [required] +**last_run_at** | **datetime** | The most recent date and time this report was run | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_report import CampaignReport + +campaign_report = CampaignReport( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation', +status='PENDING', +report_type='CAMPAIGN_COMPOSITION_REPORT', +last_run_at=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignReportsConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..1df652f4c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignReportsConfig.md @@ -0,0 +1,33 @@ +--- +id: v2024-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReportsConfig', 'V2024CampaignReportsConfig'] +slug: /tools/sdk/python/v2024/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'V2024CampaignReportsConfig'] +--- + +# CampaignReportsConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attribute_columns** | **[]str** | list of identity attribute columns | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig + +campaign_reports_config = CampaignReportsConfig( +identity_attribute_columns=[firstname, lastname] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignTemplate.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignTemplate.md new file mode 100644 index 000000000..25430aba1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignTemplate.md @@ -0,0 +1,54 @@ +--- +id: v2024-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignTemplate', 'V2024CampaignTemplate'] +slug: /tools/sdk/python/v2024/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'V2024CampaignTemplate'] +--- + +# CampaignTemplate + +Campaign Template + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign template | [optional] +**name** | **str** | This template's name. Has no bearing on generated campaigns' names. | [required] +**description** | **str** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] +**created** | **datetime** | Creation date of Campaign Template | [required][readonly] +**modified** | **datetime** | Modification date of Campaign Template | [required][readonly] +**scheduled** | **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to False] +**owner_ref** | [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**deadline_duration** | **str** | 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). | [optional] +**campaign** | [**Campaign**](campaign) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_template import CampaignTemplate + +campaign_template = CampaignTemplate( +id='2c9079b270a266a60170a277bb960008', +name='Manager Campaign Template', +description='Template for the annual manager campaign.', +created='2020-03-05T22:44:00.364Z', +modified='2020-03-05T22:52:09.969Z', +scheduled=False, +owner_ref=sailpoint.v2024.models.campaign_template_owner_ref.CampaignTemplate_ownerRef( + id = '2c918086676d3e0601677611dbde220f', + type = 'IDENTITY', + name = 'Mister Manager', + email = 'mr.manager@example.com', ), +deadline_duration='P2W', +campaign=sailpoint.v2024.models.campaign.Campaign() +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..d605a0c3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,40 @@ +--- +id: v2024-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignTemplateOwnerRef', 'V2024CampaignTemplateOwnerRef'] +slug: /tools/sdk/python/v2024/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'V2024CampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the owner | [optional] +**type** | **Enum** [ 'IDENTITY' ] | Type of the owner | [optional] +**name** | **str** | Name of the owner | [optional] +**email** | **str** | Email of the owner | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaign_template_owner_ref import CampaignTemplateOwnerRef + +campaign_template_owner_ref = CampaignTemplateOwnerRef( +id='2c918086676d3e0601677611dbde220f', +type='IDENTITY', +name='Mister Manager', +email='mr.manager@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..8d3b5fe4b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CampaignsDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignsDeleteRequest', 'V2024CampaignsDeleteRequest'] +slug: /tools/sdk/python/v2024/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'V2024CampaignsDeleteRequest'] +--- + +# CampaignsDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The ids of the campaigns to delete | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.campaigns_delete_request import CampaignsDeleteRequest + +campaigns_delete_request = CampaignsDeleteRequest( +ids=[2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CancelAccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CancelAccessRequest.md new file mode 100644 index 000000000..8df6dd34e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CancelAccessRequest.md @@ -0,0 +1,36 @@ +--- +id: v2024-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelAccessRequest', 'V2024CancelAccessRequest'] +slug: /tools/sdk/python/v2024/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'V2024CancelAccessRequest'] +--- + +# CancelAccessRequest + +Request body payload for cancel access request endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_activity_id** | **str** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] +**comment** | **str** | Reason for cancelling the pending access request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.cancel_access_request import CancelAccessRequest + +cancel_access_request = CancelAccessRequest( +account_activity_id='2c9180835d2e5168015d32f890ca1581', +comment='I requested this role by mistake.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CancelledRequestDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..327928123 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CancelledRequestDetails.md @@ -0,0 +1,41 @@ +--- +id: v2024-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelledRequestDetails', 'V2024CancelledRequestDetails'] +slug: /tools/sdk/python/v2024/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'V2024CancelledRequestDetails'] +--- + +# CancelledRequestDetails + +Provides additional details for a request that has been cancelled. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.cancelled_request_details import CancelledRequestDetails + +cancelled_request_details = CancelledRequestDetails( +comment='This request must be cancelled.', +owner=sailpoint.v2024.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +modified='2019-12-20T09:17:12.192Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Certification.md b/docs/tools/sdk/python/Reference/V2024/Models/Certification.md new file mode 100644 index 000000000..486e84f62 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Certification.md @@ -0,0 +1,90 @@ +--- +id: v2024-certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification', 'V2024Certification'] +slug: /tools/sdk/python/v2024/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'V2024Certification'] +--- + +# Certification + + +## 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.certification import Certification + +certification = Certification( +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/CertificationDecision.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationDecision.md new file mode 100644 index 000000000..fca86e27f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationDecision.md @@ -0,0 +1,23 @@ +--- +id: v2024-certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationDecision', 'V2024CertificationDecision'] +slug: /tools/sdk/python/v2024/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'V2024CertificationDecision'] +--- + +# CertificationDecision + +The decision to approve or revoke the review item + +## Enum + +* `APPROVE` (value: `'APPROVE'`) + +* `REVOKE` (value: `'REVOKE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationDto.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationDto.md new file mode 100644 index 000000000..0af4e8425 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationDto.md @@ -0,0 +1,82 @@ +--- +id: v2024-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationDto', 'V2024CertificationDto'] +slug: /tools/sdk/python/v2024/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'V2024CertificationDto'] +--- + +# CertificationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign_ref** | [**CampaignReference**](campaign-reference) | | [required] +**phase** | [**CertificationPhase**](certification-phase) | | [required] +**due** | **datetime** | The due date of the certification. | [required] +**signed** | **datetime** | The date the reviewer signed off on the certification. | [required] +**reviewer** | [**Reviewer**](reviewer) | | [required] +**reassignment** | [**Reassignment**](reassignment) | | [optional] +**has_errors** | **bool** | Indicates it the certification has any errors. | [required] +**error_message** | **str** | A message indicating what the error is. | [optional] +**completed** | **bool** | Indicates if all certification decisions have been made. | [required] +**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**entities_completed** | **int** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**entities_total** | **int** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.certification_dto import CertificationDto + +certification_dto = CertificationDto( +campaign_ref=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', ), +phase='ACTIVE', +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', +completed=False, +decisions_made=20, +decisions_total=40, +entities_completed=5, +entities_total=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationIdentitySummary.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..7633fba88 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationIdentitySummary.md @@ -0,0 +1,39 @@ +--- +id: v2024-certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationIdentitySummary', 'V2024CertificationIdentitySummary'] +slug: /tools/sdk/python/v2024/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'V2024CertificationIdentitySummary'] +--- + +# CertificationIdentitySummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the identity summary | [optional] +**name** | **str** | Name of the linked identity | [optional] +**identity_id** | **str** | The ID of the identity being certified | [optional] +**completed** | **bool** | Indicates whether the review items for the linked identity's certification have been completed | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary + +certification_identity_summary = CertificationIdentitySummary( +id='2c91808772a504f50172a9540e501ba7', +name='Alison Ferguso', +identity_id='2c9180857182306001719937377a33de', +completed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationPhase.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationPhase.md new file mode 100644 index 000000000..2703fc6e6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationPhase.md @@ -0,0 +1,25 @@ +--- +id: v2024-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationPhase', 'V2024CertificationPhase'] +slug: /tools/sdk/python/v2024/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'V2024CertificationPhase'] +--- + +# CertificationPhase + +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` (value: `'STAGED'`) + +* `ACTIVE` (value: `'ACTIVE'`) + +* `SIGNED` (value: `'SIGNED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationReference.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationReference.md new file mode 100644 index 000000000..e1fa2e9d2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationReference.md @@ -0,0 +1,45 @@ +--- +id: v2024-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationReference', 'V2024CertificationReference'] +slug: /tools/sdk/python/v2024/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'V2024CertificationReference'] +--- + +# CertificationReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the certification. | [optional] +**name** | **str** | The name of the certification. | [optional] +**type** | **Enum** [ 'CERTIFICATION' ] | | [optional] +**reviewer** | [**Reviewer**](reviewer) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.certification_reference import CertificationReference + +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', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOff.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOff.md new file mode 100644 index 000000000..c0fe6e983 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOff.md @@ -0,0 +1,37 @@ +--- +id: v2024-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationSignedOff', 'V2024CertificationSignedOff'] +slug: /tools/sdk/python/v2024/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'V2024CertificationSignedOff'] +--- + +# CertificationSignedOff + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.certification_signed_off import CertificationSignedOff + +certification_signed_off = CertificationSignedOff( +certification=sailpoint.v2024.models.certification_signed_off_certification.CertificationSignedOff_certification( + id = '2c91808576f886190176f88caf0d0067', + name = 'Manager Access Review for Alice Baker', + created = '2020-02-16T03:04:45.815Z', + modified = '2020-02-16T03:06:45.815Z', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..2fefca50d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOffCertification.md @@ -0,0 +1,91 @@ +--- +id: v2024-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationSignedOffCertification', 'V2024CertificationSignedOffCertification'] +slug: /tools/sdk/python/v2024/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'V2024CertificationSignedOffCertification'] +--- + +# CertificationSignedOffCertification + +The certification campaign that was signed off on. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID of the certification. | [required] +**name** | **str** | The name of the certification. | [required] +**created** | **datetime** | The date and time the certification was created. | [required] +**modified** | **datetime** | The date and time the certification was last modified. | [optional] +**campaign_ref** | [**CampaignReference**](campaign-reference) | | [required] +**phase** | [**CertificationPhase**](certification-phase) | | [required] +**due** | **datetime** | The due date of the certification. | [required] +**signed** | **datetime** | The date the reviewer signed off on the certification. | [required] +**reviewer** | [**Reviewer**](reviewer) | | [required] +**reassignment** | [**Reassignment**](reassignment) | | [optional] +**has_errors** | **bool** | Indicates it the certification has any errors. | [required] +**error_message** | **str** | A message indicating what the error is. | [optional] +**completed** | **bool** | Indicates if all certification decisions have been made. | [required] +**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**entities_completed** | **int** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**entities_total** | **int** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.certification_signed_off_certification import CertificationSignedOffCertification + +certification_signed_off_certification = CertificationSignedOffCertification( +id='2c91808576f886190176f88caf0d0067', +name='Manager Access Review for Alice Baker', +created='2020-02-16T03:04:45.815Z', +modified='2020-02-16T03:06:45.815Z', +campaign_ref=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', ), +phase='ACTIVE', +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', +completed=False, +decisions_made=20, +decisions_total=40, +entities_completed=5, +entities_total=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertificationTask.md b/docs/tools/sdk/python/Reference/V2024/Models/CertificationTask.md new file mode 100644 index 000000000..38aac5960 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertificationTask.md @@ -0,0 +1,47 @@ +--- +id: v2024-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationTask', 'V2024CertificationTask'] +slug: /tools/sdk/python/v2024/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'V2024CertificationTask'] +--- + +# CertificationTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification task. | [optional] +**type** | **Enum** [ 'REASSIGN', 'ADMIN_REASSIGN', 'COMPLETE_CERTIFICATION', 'FINISH_CERTIFICATION', 'COMPLETE_CAMPAIGN', 'ACTIVATE_CAMPAIGN', 'CAMPAIGN_CREATE', 'CAMPAIGN_DELETE' ] | The type of the certification task. More values may be added in the future. | [optional] +**target_type** | **Enum** [ 'CERTIFICATION', 'CAMPAIGN' ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**target_id** | **str** | The ID of the item being operated on by this task. | [optional] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The status of the task. | [optional] +**errors** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional] +**reassignment_trail_dtos** | [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**created** | **datetime** | The date and time on which this task was created. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.certification_task import CertificationTask + +certification_task = CertificationTask( +id='2c918086719eec070171a7e3355a360a', +type='ADMIN_REASSIGN', +target_type='CAMPAIGN', +target_id='2c918086719eec070171a7e3355a834c', +status='QUEUED', +errors={locale=en-US, localeOrigin=DEFAULT, text=Error Message}, +reassignment_trail_dtos={previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT}, +created='2020-09-24T18:10:47.693Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CertifierResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/CertifierResponse.md new file mode 100644 index 000000000..e21b8f121 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CertifierResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertifierResponse', 'V2024CertifierResponse'] +slug: /tools/sdk/python/v2024/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'V2024CertifierResponse'] +--- + +# CertifierResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of the certifier | [optional] +**display_name** | **str** | the name of the certifier | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.certifier_response import CertifierResponse + +certifier_response = CertifierResponse( +id='8a80828f643d484f01643e14202e206f', +display_name='John Snow' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..7d5a5e03d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfiguration.md @@ -0,0 +1,42 @@ +--- +id: v2024-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfiguration', 'V2024ClientLogConfiguration'] +slug: /tools/sdk/python/v2024/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'V2024ClientLogConfiguration'] +--- + +# ClientLogConfiguration + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**expiration** | **datetime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration + +client_log_configuration = ClientLogConfiguration( +client_id='3a38a51992e8445ab51a549c0a70ee66', +duration_minutes=120, +expiration='2024-11-06T01:31:08.013164Z', +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..3668d5872 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,40 @@ +--- +id: v2024-client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfigurationDurationMinutes', 'V2024ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/python/v2024/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'V2024ClientLogConfigurationDurationMinutes'] +--- + +# ClientLogConfigurationDurationMinutes + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.client_log_configuration_duration_minutes import ClientLogConfigurationDurationMinutes + +client_log_configuration_duration_minutes = ClientLogConfigurationDurationMinutes( +client_id='3a38a51992e8445ab51a549c0a70ee66', +duration_minutes=120, +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..914135bac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,40 @@ +--- +id: v2024-client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfigurationExpiration', 'V2024ClientLogConfigurationExpiration'] +slug: /tools/sdk/python/v2024/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'V2024ClientLogConfigurationExpiration'] +--- + +# ClientLogConfigurationExpiration + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**expiration** | **datetime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.client_log_configuration_expiration import ClientLogConfigurationExpiration + +client_log_configuration_expiration = ClientLogConfigurationExpiration( +client_id='3a38a51992e8445ab51a549c0a70ee66', +expiration='2024-11-06T01:31:08.013164Z', +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ClientType.md b/docs/tools/sdk/python/Reference/V2024/Models/ClientType.md new file mode 100644 index 000000000..4ec26bc05 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ClientType.md @@ -0,0 +1,23 @@ +--- +id: v2024-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientType', 'V2024ClientType'] +slug: /tools/sdk/python/v2024/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'V2024ClientType'] +--- + +# ClientType + +Type of an API Client indicating public or confidentials use + +## Enum + +* `CONFIDENTIAL` (value: `'CONFIDENTIAL'`) + +* `PUBLIC` (value: `'PUBLIC'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CloseAccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CloseAccessRequest.md new file mode 100644 index 000000000..e6290a37d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CloseAccessRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CloseAccessRequest', 'V2024CloseAccessRequest'] +slug: /tools/sdk/python/v2024/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'V2024CloseAccessRequest'] +--- + +# CloseAccessRequest + +Request body payload for close access requests endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_ids** | **[]str** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [required] +**message** | **str** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to 'The IdentityNow Administrator manually closed this request.'] +**execution_status** | **Enum** [ 'Terminated', 'Completed' ] | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to 'Terminated'] +**completion_status** | **Enum** [ 'Success', 'Incomplete', 'Failure' ] | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to 'Failure'] +} + +## Example + +```python +from sailpoint.v2024.models.close_access_request import CloseAccessRequest + +close_access_request = CloseAccessRequest( +access_request_ids=[2c90ad2a70ace7d50170acf22ca90010], +message='The IdentityNow Administrator manually closed this request.', +execution_status='Terminated', +completion_status='Failure' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Column.md b/docs/tools/sdk/python/Reference/V2024/Models/Column.md new file mode 100644 index 000000000..6fc3279ec --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Column.md @@ -0,0 +1,35 @@ +--- +id: v2024-column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Column', 'V2024Column'] +slug: /tools/sdk/python/v2024/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'V2024Column'] +--- + +# Column + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_field** | **str** | The name of the field. | [required] +**header** | **str** | The value of the header. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.column import Column + +column = Column( +var_field='email', +header='Work Email' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Comment.md b/docs/tools/sdk/python/Reference/V2024/Models/Comment.md new file mode 100644 index 000000000..979319034 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Comment.md @@ -0,0 +1,39 @@ +--- +id: v2024-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Comment', 'V2024Comment'] +slug: /tools/sdk/python/v2024/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'V2024Comment'] +--- + +# Comment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commenter_id** | **str** | Id of the identity making the comment | [optional] +**commenter_name** | **str** | Human-readable display name of the identity making the comment | [optional] +**body** | **str** | Content of the comment | [optional] +**var_date** | **datetime** | Date and time comment was made | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.comment import Comment + +comment = Comment( +commenter_id='2c918084660f45d6016617daa9210584', +commenter_name='Adam Kennedy', +body='Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', +var_date='2017-07-11T18:45:37.098Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommentDto.md b/docs/tools/sdk/python/Reference/V2024/Models/CommentDto.md new file mode 100644 index 000000000..b36304ac1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommentDto.md @@ -0,0 +1,40 @@ +--- +id: v2024-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDto', 'V2024CommentDto'] +slug: /tools/sdk/python/v2024/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'V2024CommentDto'] +--- + +# CommentDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.comment_dto import CommentDto + +comment_dto = CommentDto( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommentDtoAuthor.md b/docs/tools/sdk/python/Reference/V2024/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..4bda9afed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommentDtoAuthor.md @@ -0,0 +1,38 @@ +--- +id: v2024-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDtoAuthor', 'V2024CommentDtoAuthor'] +slug: /tools/sdk/python/v2024/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'V2024CommentDtoAuthor'] +--- + +# CommentDtoAuthor + +Author of the comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional] +**id** | **str** | The unique ID of the object | [optional] +**name** | **str** | The display name of the object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.comment_dto_author import CommentDtoAuthor + +comment_dto_author = CommentDtoAuthor( +type='IDENTITY', +id='2c9180847e25f377017e2ae8cae4650b', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessIDStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..6ad981516 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessIDStatus.md @@ -0,0 +1,39 @@ +--- +id: v2024-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessIDStatus', 'V2024CommonAccessIDStatus'] +slug: /tools/sdk/python/v2024/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'V2024CommonAccessIDStatus'] +--- + +# CommonAccessIDStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**confirmed_ids** | **[]str** | List of confirmed common access ids. | [optional] +**denied_ids** | **[]str** | List of denied common access ids. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.common_access_id_status import CommonAccessIDStatus + +common_access_id_status = CommonAccessIDStatus( +confirmed_ids=[ + '' + ], +denied_ids=[ + '' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..c08776a10 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemAccess.md @@ -0,0 +1,43 @@ +--- +id: v2024-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemAccess', 'V2024CommonAccessItemAccess'] +slug: /tools/sdk/python/v2024/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'V2024CommonAccessItemAccess'] +--- + +# CommonAccessItemAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Common access ID | [optional] +**type** | [**CommonAccessType**](common-access-type) | | [optional] +**name** | **str** | Common access name | [optional] +**description** | **str** | Common access description | [optional] +**owner_name** | **str** | Common access owner name | [optional] +**owner_id** | **str** | Common access owner ID | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.common_access_item_access import CommonAccessItemAccess + +common_access_item_access = CommonAccessItemAccess( +id='', +type='ACCESS_PROFILE', +name='', +description='', +owner_name='', +owner_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..06228f980 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemRequest', 'V2024CommonAccessItemRequest'] +slug: /tools/sdk/python/v2024/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'V2024CommonAccessItemRequest'] +--- + +# CommonAccessItemRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**status** | [**CommonAccessItemState**](common-access-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.common_access_item_request import CommonAccessItemRequest + +common_access_item_request = CommonAccessItemRequest( +access=sailpoint.v2024.models.common_access_item_access.CommonAccessItemAccess( + id = '', + type = 'ACCESS_PROFILE', + name = '', + description = '', + owner_name = '', + owner_id = '', ), +status='CONFIRMED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..6e4b46186 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemResponse.md @@ -0,0 +1,51 @@ +--- +id: v2024-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemResponse', 'V2024CommonAccessItemResponse'] +slug: /tools/sdk/python/v2024/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'V2024CommonAccessItemResponse'] +--- + +# CommonAccessItemResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Common Access Item ID | [optional] +**access** | [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**status** | [**CommonAccessItemState**](common-access-item-state) | | [optional] +**last_updated** | **str** | | [optional] +**reviewed_by_user** | **bool** | | [optional] +**last_reviewed** | **str** | | [optional] +**created_by_user** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.common_access_item_response import CommonAccessItemResponse + +common_access_item_response = CommonAccessItemResponse( +id='', +access=sailpoint.v2024.models.common_access_item_access.CommonAccessItemAccess( + id = '', + type = 'ACCESS_PROFILE', + name = '', + description = '', + owner_name = '', + owner_id = '', ), +status='CONFIRMED', +last_updated='', +reviewed_by_user=True, +last_reviewed='', +created_by_user='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemState.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemState.md new file mode 100644 index 000000000..272837ded --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessItemState.md @@ -0,0 +1,23 @@ +--- +id: v2024-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessItemState', 'V2024CommonAccessItemState'] +slug: /tools/sdk/python/v2024/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'V2024CommonAccessItemState'] +--- + +# CommonAccessItemState + +State of common access item. + +## Enum + +* `CONFIRMED` (value: `'CONFIRMED'`) + +* `DENIED` (value: `'DENIED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessResponse.md new file mode 100644 index 000000000..1350832a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessResponse.md @@ -0,0 +1,53 @@ +--- +id: v2024-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessResponse', 'V2024CommonAccessResponse'] +slug: /tools/sdk/python/v2024/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'V2024CommonAccessResponse'] +--- + +# CommonAccessResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID of the common access item | [optional] +**access** | [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**status** | **str** | CONFIRMED or DENIED | [optional] +**common_access_type** | **str** | | [optional] +**last_updated** | **datetime** | | [optional] [readonly] +**reviewed_by_user** | **bool** | true if user has confirmed or denied status | [optional] +**last_reviewed** | **datetime** | | [optional] [readonly] +**created_by_user** | **bool** | | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.common_access_response import CommonAccessResponse + +common_access_response = CommonAccessResponse( +id='555ab47a-0d32-4813-906f-adf3567de6a4', +access=sailpoint.v2024.models.common_access_item_access.CommonAccessItemAccess( + id = '', + type = 'ACCESS_PROFILE', + name = '', + description = '', + owner_name = '', + owner_id = '', ), +status='', +common_access_type='UNSET', +last_updated=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +reviewed_by_user=True, +last_reviewed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +created_by_user=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessType.md b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessType.md new file mode 100644 index 000000000..b8081a05e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CommonAccessType.md @@ -0,0 +1,23 @@ +--- +id: v2024-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommonAccessType', 'V2024CommonAccessType'] +slug: /tools/sdk/python/v2024/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'V2024CommonAccessType'] +--- + +# CommonAccessType + +The type of access item. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompleteInvocation.md b/docs/tools/sdk/python/Reference/V2024/Models/CompleteInvocation.md new file mode 100644 index 000000000..c84a0f19a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompleteInvocation.md @@ -0,0 +1,37 @@ +--- +id: v2024-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompleteInvocation', 'V2024CompleteInvocation'] +slug: /tools/sdk/python/v2024/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'V2024CompleteInvocation'] +--- + +# CompleteInvocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**secret** | **str** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | [required] +**error** | **str** | The error message to indicate a failed invocation or error if any. | [optional] +**output** | **object** | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.complete_invocation import CompleteInvocation + +complete_invocation = CompleteInvocation( +secret='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +error='Access request is denied.', +output={approved=false} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompleteInvocationInput.md b/docs/tools/sdk/python/Reference/V2024/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..1c15eba6c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompleteInvocationInput.md @@ -0,0 +1,37 @@ +--- +id: v2024-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompleteInvocationInput', 'V2024CompleteInvocationInput'] +slug: /tools/sdk/python/v2024/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'V2024CompleteInvocationInput'] +--- + +# CompleteInvocationInput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**localized_error** | [**LocalizedMessage**](localized-message) | | [optional] +**output** | **object** | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.complete_invocation_input import CompleteInvocationInput + +complete_invocation_input = CompleteInvocationInput( +localized_error=sailpoint.v2024.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), +output={approved=false} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompletedApproval.md b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApproval.md new file mode 100644 index 000000000..801d8aced --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApproval.md @@ -0,0 +1,143 @@ +--- +id: v2024-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApproval', 'V2024CompletedApproval'] +slug: /tools/sdk/python/v2024/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'V2024CompletedApproval'] +--- + +# CompletedApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval id. | [optional] +**name** | **str** | The name of the approval. | [optional] +**created** | **datetime** | When the approval was created. | [optional] +**modified** | **datetime** | When the approval was modified last time. | [optional] +**request_created** | **datetime** | When the access-request was created. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**reviewed_by** | [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**requested_object** | [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**requester_comment** | [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**reviewer_comment** | [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**previous_reviewers_comments** | [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**comment_required_when_rejected** | **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to False] +**state** | [**CompletedApprovalState**](completed-approval-state) | | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**remove_date_update_requested** | **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to False] +**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**sod_violation_context** | [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**pre_approval_trigger_result** | [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs provided during the request. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.completed_approval import CompletedApproval + +completed_approval = CompletedApproval( +id='id12345', +name='aName', +created='2017-07-11T18:45:37.098Z', +modified='2018-07-25T20:22:28.104Z', +request_created='2017-07-11T18:45:35.098Z', +request_type='GRANT_ACCESS', +requester=sailpoint.v2024.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v2024.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +reviewed_by=sailpoint.v2024.models.access_item_reviewed_by.AccessItemReviewedBy( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +owner=sailpoint.v2024.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +requested_object=sailpoint.v2024.models.requestable_object_reference.RequestableObjectReference( + id = '2c9180835d2e5168015d32f890ca1581', + name = 'Applied Research Access', + description = 'Access to research information, lab results, and schematics', + type = 'ROLE', ), +requester_comment=, +reviewer_comment=, +previous_reviewers_comments=[ + sailpoint.v2024.models.comment_dto.CommentDto( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ) + ], +forward_history=[ + sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], +comment_required_when_rejected=True, +state='APPROVED', +remove_date='2020-07-11T00:00Z', +remove_date_update_requested=True, +current_remove_date='2020-07-11T00:00Z', +sod_violation_context=sailpoint.v2024.models.sod_violation_context_check_completed.SodViolationContextCheckCompleted( + state = 'SUCCESS', + uuid = 'f73d16e9-a038-46c5-b217-1246e15fdbdd', + violation_check_result = sailpoint.v2024.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v2024.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ), ), +pre_approval_trigger_result=sailpoint.v2024.models.completed_approval_pre_approval_trigger_result.CompletedApproval_preApprovalTriggerResult( + comment = 'This request was autoapproved by our automated ETS subscriber', + decision = 'APPROVED', + reviewer = 'Automated AR Approval', + date = '2022-06-07T19:18:40.748Z', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..ad216c480 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,40 @@ +--- +id: v2024-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'V2024CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/python/v2024/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'V2024CompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | The comment from the trigger | [optional] +**decision** | [**CompletedApprovalState**](completed-approval-state) | | [optional] +**reviewer** | **str** | The name of the approver | [optional] +**var_date** | **datetime** | The date and time the trigger decided on the request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.completed_approval_pre_approval_trigger_result import CompletedApprovalPreApprovalTriggerResult + +completed_approval_pre_approval_trigger_result = CompletedApprovalPreApprovalTriggerResult( +comment='This request was autoapproved by our automated ETS subscriber', +decision='APPROVED', +reviewer='Automated AR Approval', +var_date='2022-06-07T19:18:40.748Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..de773f3be --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,40 @@ +--- +id: v2024-completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalRequesterComment', 'V2024CompletedApprovalRequesterComment'] +slug: /tools/sdk/python/v2024/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'V2024CompletedApprovalRequesterComment'] +--- + +# CompletedApprovalRequesterComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.completed_approval_requester_comment import CompletedApprovalRequesterComment + +completed_approval_requester_comment = CompletedApprovalRequesterComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..76c06d62c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,40 @@ +--- +id: v2024-completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalReviewerComment', 'V2024CompletedApprovalReviewerComment'] +slug: /tools/sdk/python/v2024/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'V2024CompletedApprovalReviewerComment'] +--- + +# CompletedApprovalReviewerComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.completed_approval_reviewer_comment import CompletedApprovalReviewerComment + +completed_approval_reviewer_comment = CompletedApprovalReviewerComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalState.md b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalState.md new file mode 100644 index 000000000..f8b0eb04d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompletedApprovalState.md @@ -0,0 +1,23 @@ +--- +id: v2024-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalState', 'V2024CompletedApprovalState'] +slug: /tools/sdk/python/v2024/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'V2024CompletedApprovalState'] +--- + +# CompletedApprovalState + +Enum represents completed approval object's state. + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CompletionStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/CompletionStatus.md new file mode 100644 index 000000000..94c5d239a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CompletionStatus.md @@ -0,0 +1,27 @@ +--- +id: v2024-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletionStatus', 'V2024CompletionStatus'] +slug: /tools/sdk/python/v2024/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'V2024CompletionStatus'] +--- + +# CompletionStatus + +The status after completion. + +## Enum + +* `SUCCESS` (value: `'SUCCESS'`) + +* `FAILURE` (value: `'FAILURE'`) + +* `INCOMPLETE` (value: `'INCOMPLETE'`) + +* `PENDING` (value: `'PENDING'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConditionEffect.md b/docs/tools/sdk/python/Reference/V2024/Models/ConditionEffect.md new file mode 100644 index 000000000..f5786dc52 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConditionEffect.md @@ -0,0 +1,38 @@ +--- +id: v2024-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConditionEffect', 'V2024ConditionEffect'] +slug: /tools/sdk/python/v2024/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'V2024ConditionEffect'] +--- + +# ConditionEffect + +Effect produced by a condition. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**effect_type** | **Enum** [ 'HIDE', 'SHOW', 'DISABLE', 'ENABLE', 'REQUIRE', 'OPTIONAL', 'SUBMIT_MESSAGE', 'SUBMIT_NOTIFICATION', 'SET_DEFAULT_VALUE' ] | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**config** | [**ConditionEffectConfig**](condition-effect-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.condition_effect import ConditionEffect + +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/ConditionEffectConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..da64796f0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConditionEffectConfig.md @@ -0,0 +1,36 @@ +--- +id: v2024-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConditionEffectConfig', 'V2024ConditionEffectConfig'] +slug: /tools/sdk/python/v2024/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'V2024ConditionEffectConfig'] +--- + +# ConditionEffectConfig + +Arbitrary map containing a configuration based on the EffectType. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default_value_label** | **str** | Effect type's label. | [optional] +**element** | **str** | Element's identifier. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.condition_effect_config import ConditionEffectConfig + +condition_effect_config = ConditionEffectConfig( +default_value_label='Access to Remove', +element='8110662963316867' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConditionRule.md b/docs/tools/sdk/python/Reference/V2024/Models/ConditionRule.md new file mode 100644 index 000000000..c3448d3a4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConditionRule.md @@ -0,0 +1,41 @@ +--- +id: v2024-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConditionRule', 'V2024ConditionRule'] +slug: /tools/sdk/python/v2024/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'V2024ConditionRule'] +--- + +# ConditionRule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_type** | **Enum** [ 'INPUT', 'ELEMENT' ] | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**source** | **str** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**operator** | **Enum** [ 'EQ', 'NE', 'CO', 'NOT_CO', 'IN', 'NOT_IN', 'EM', 'NOT_EM', 'SW', 'NOT_SW', 'EW', 'NOT_EW' ] | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**value_type** | **Enum** [ 'STRING', 'STRING_LIST', 'INPUT', 'ELEMENT', 'LIST', 'BOOLEAN' ] | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**value** | **str** | Based on the ValueType. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.condition_rule import ConditionRule + +condition_rule = ConditionRule( +source_type='ELEMENT', +source='department', +operator='EQ', +value_type='STRING', +value='Engineering' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigObject.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigObject.md new file mode 100644 index 000000000..2575034f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigObject.md @@ -0,0 +1,41 @@ +--- +id: v2024-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigObject', 'V2024ConfigObject'] +slug: /tools/sdk/python/v2024/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'V2024ConfigObject'] +--- + +# ConfigObject + +Config export and import format for individual object configurations. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Current version of configuration object. | [optional] +**var_self** | [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**object** | **map[string]object** | Object details. Format dependant on the object type. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.config_object import ConfigObject + +config_object = ConfigObject( +version=1, +var_self=sailpoint.v2024.models.self_import_export_dto.SelfImportExportDto( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +object={ } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigType.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigType.md new file mode 100644 index 000000000..74d4e7e6d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigType.md @@ -0,0 +1,42 @@ +--- +id: v2024-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigType', 'V2024ConfigType'] +slug: /tools/sdk/python/v2024/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'V2024ConfigType'] +--- + +# ConfigType + +Type of Reassignment Configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**priority** | **int** | | [optional] +**internal_name** | [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**internal_name_camel** | [**ConfigTypeEnum**](config-type-enum) | | [optional] +**display_name** | **str** | Human readable display name of the type to be shown on UI | [optional] +**description** | **str** | Description of the type of work to be reassigned, displayed by the UI. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.config_type import ConfigType + +config_type = ConfigType( +priority=1, +internal_name='accessRequests', +internal_name_camel='ACCESS_REQUESTS', +display_name='Access Requests', +description='Reassign Access Request Work Items for an identity' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigTypeEnum.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..68011b66d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigTypeEnum.md @@ -0,0 +1,25 @@ +--- +id: v2024-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigTypeEnum', 'V2024ConfigTypeEnum'] +slug: /tools/sdk/python/v2024/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'V2024ConfigTypeEnum'] +--- + +# ConfigTypeEnum + +Enum list of valid work types that can be selected for a Reassignment Configuration + +## Enum + +* `ACCESS_REQUESTS` (value: `'ACCESS_REQUESTS'`) + +* `CERTIFICATIONS` (value: `'CERTIFICATIONS'`) + +* `MANUAL_TASKS` (value: `'MANUAL_TASKS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..c068cb32a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,25 @@ +--- +id: v2024-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigTypeEnumCamel', 'V2024ConfigTypeEnumCamel'] +slug: /tools/sdk/python/v2024/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'V2024ConfigTypeEnumCamel'] +--- + +# ConfigTypeEnumCamel + +Enum list of valid work types that can be selected for a Reassignment Configuration + +## Enum + +* `ACCESSREQUESTS` (value: `'accessRequests'`) + +* `CERTIFICATIONS` (value: `'certifications'`) + +* `MANUALTASKS` (value: `'manualTasks'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..9eb12d5c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,52 @@ +--- +id: v2024-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationDetailsResponse', 'V2024ConfigurationDetailsResponse'] +slug: /tools/sdk/python/v2024/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'V2024ConfigurationDetailsResponse'] +--- + +# ConfigurationDetailsResponse + +The request body of Reassignment Configuration Details for a specific identity and config type + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config_type** | [**ConfigTypeEnum**](config-type-enum) | | [optional] +**target_identity** | [**Identity1**](identity1) | | [optional] +**start_date** | **datetime** | The date from which to start reassigning work items | [optional] +**end_date** | **datetime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**audit_details** | [**AuditDetails**](audit-details) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.configuration_details_response import ConfigurationDetailsResponse + +configuration_details_response = ConfigurationDetailsResponse( +config_type='ACCESS_REQUESTS', +target_identity=sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +start_date='2022-07-21T11:13:12.345Z', +end_date='0001-01-01T00:00Z', +audit_details=sailpoint.v2024.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationItemRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..d001cd6c0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationItemRequest.md @@ -0,0 +1,42 @@ +--- +id: v2024-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationItemRequest', 'V2024ConfigurationItemRequest'] +slug: /tools/sdk/python/v2024/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'V2024ConfigurationItemRequest'] +--- + +# ConfigurationItemRequest + +The request body for creation or update of a Reassignment Configuration for a single identity and work type + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassigned_from_id** | **str** | The identity id to reassign an item from | [optional] +**reassigned_to_id** | **str** | The identity id to reassign an item to | [optional] +**config_type** | [**ConfigTypeEnum**](config-type-enum) | | [optional] +**start_date** | **datetime** | The date from which to start reassigning work items | [optional] +**end_date** | **datetime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest + +configuration_item_request = ConfigurationItemRequest( +reassigned_from_id='2c91808781a71ddb0181b9090b5c504e', +reassigned_to_id='2c91808781a71ddb0181b9090b53504a', +config_type='ACCESS_REQUESTS', +start_date='2022-07-21T11:13:12.345Z', +end_date='2022-07-30T17:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationItemResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..9abad4286 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationItemResponse.md @@ -0,0 +1,53 @@ +--- +id: v2024-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationItemResponse', 'V2024ConfigurationItemResponse'] +slug: /tools/sdk/python/v2024/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'V2024ConfigurationItemResponse'] +--- + +# ConfigurationItemResponse + +The response body of a Reassignment Configuration for a single identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**Identity1**](identity1) | | [optional] +**config_details** | [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse + +configuration_item_response = ConfigurationItemResponse( +identity=sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +config_details=[ + sailpoint.v2024.models.configuration_details_response.ConfigurationDetailsResponse( + config_type = 'ACCESS_REQUESTS', + target_identity = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + start_date = '2022-07-21T11:13:12.345Z', + end_date = '0001-01-01T00:00Z', + audit_details = sailpoint.v2024.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = , ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationResponse.md new file mode 100644 index 000000000..d82821043 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConfigurationResponse.md @@ -0,0 +1,53 @@ +--- +id: v2024-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConfigurationResponse', 'V2024ConfigurationResponse'] +slug: /tools/sdk/python/v2024/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'V2024ConfigurationResponse'] +--- + +# ConfigurationResponse + +The response body of a Reassignment Configuration for a single identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**Identity1**](identity1) | | [optional] +**config_details** | [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.configuration_response import ConfigurationResponse + +configuration_response = ConfigurationResponse( +identity=sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), +config_details=[ + sailpoint.v2024.models.configuration_details_response.ConfigurationDetailsResponse( + config_type = 'ACCESS_REQUESTS', + target_identity = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + start_date = '2022-07-21T11:13:12.345Z', + end_date = '0001-01-01T00:00Z', + audit_details = sailpoint.v2024.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = , ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..b704d3ee9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: v2024-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConflictingAccessCriteria', 'V2024ConflictingAccessCriteria'] +slug: /tools/sdk/python/v2024/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'V2024ConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +**right_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.conflicting_access_criteria import ConflictingAccessCriteria + +conflicting_access_criteria = ConflictingAccessCriteria( +left_criteria=sailpoint.v2024.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.v2024.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectedObject.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectedObject.md new file mode 100644 index 000000000..40e2bbb31 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectedObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectedObject', 'V2024ConnectedObject'] +slug: /tools/sdk/python/v2024/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'V2024ConnectedObject'] +--- + +# ConnectedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ConnectedObjectType**](connected-object-type) | | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable name of Connected object | [optional] +**description** | **str** | Description of the Connected object. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.connected_object import ConnectedObject + +connected_object = ConnectedObject( +type=, +id='2c91808568c529c60168cca6f90c1313', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectedObjectType.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectedObjectType.md new file mode 100644 index 000000000..7cf3e9cbc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectedObjectType.md @@ -0,0 +1,27 @@ +--- +id: v2024-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectedObjectType', 'V2024ConnectedObjectType'] +slug: /tools/sdk/python/v2024/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'V2024ConnectedObjectType'] +--- + +# ConnectedObjectType + +An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +* `SOD_POLICY` (value: `'SOD_POLICY'`) + +* `SOURCE` (value: `'SOURCE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorDetail.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorDetail.md new file mode 100644 index 000000000..708bc7d44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorDetail.md @@ -0,0 +1,114 @@ +--- +id: v2024-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorDetail', 'V2024ConnectorDetail'] +slug: /tools/sdk/python/v2024/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'V2024ConnectorDetail'] +--- + +# ConnectorDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The connector name | [optional] +**type** | **str** | The connector type | [optional] +**class_name** | **str** | The connector class name | [optional] +**script_name** | **str** | The connector script name | [optional] +**application_xml** | **str** | The connector application xml | [optional] +**correlation_config_xml** | **str** | The connector correlation config xml | [optional] +**source_config_xml** | **str** | The connector source config xml | [optional] +**source_config** | **str** | The connector source config | [optional] +**source_config_from** | **str** | The connector source config origin | [optional] +**s3_location** | **str** | storage path key for this connector | [optional] +**uploaded_files** | **[]str** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**file_upload** | **bool** | true if the source is file upload | [optional] [default to False] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to False] +**translation_properties** | **map[string]object** | A map containing translation attributes by loacale key | [optional] +**connector_metadata** | **map[string]object** | A map containing metadata pertinent to the UI to be used | [optional] +**status** | **Enum** [ 'DEPRECATED', 'DEVELOPMENT', 'DEMO', 'RELEASED' ] | The connector status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.connector_detail import ConnectorDetail + +connector_detail = ConnectorDetail( +name='name', +type='ServiceNow', +class_name='class name', +script_name='servicenow', +application_xml=' + + +', +correlation_config_xml=' + + + + + + + + + + + +', +source_config_xml='
+ + + + + + +
', +source_config='
+ + + + + + +
', +source_config_from='sp-connect', +s3_location='custom-connector/scriptname', +uploaded_files=[pod/org/connectorFiles/testconnector/test1.jar], +file_upload=True, +direct_connect=True, +translation_properties={de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. +# DO NOT EDIT. This file is generated by "sailpointTranslate" command. +menuLabel_ConnectionSettings=Verbindungseinstellungen +menuLabel_AggregationSettings=Aggregationseinstellungen +sectionLabel_AuthenticationSettings=Verbindungseinstellungen +sectionLabel_AggregationSettings=Aggregationseinstellungen +sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

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..d7586d32d --- /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' ] | 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..febe6f878 --- /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' ] | 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..44d7c40d1 --- /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' ] | 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..37ecc13cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CriteriaType.md @@ -0,0 +1,39 @@ +--- +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'`) + +[[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/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..2441b8677 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EventAttributes.md @@ -0,0 +1,40 @@ +--- +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] +} + +## 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' +) + +``` +[[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..3171c7de6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,89 @@ +--- +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** | **str** | | [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='', +version=56 +) + +``` +[[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..113259932 --- /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** | Additonal 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..eaa729a01 --- /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' ] | 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/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/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 = '', + message = '', ), +accounts=[ + null + ], +account_count=3, +apps=[ + null + ], +app_count=2, +access=[ + null + ], +access_count=5, +entitlement_count=10, +role_count=1, +access_profile_count=1, +owns=[ + sailpoint.v2024.models.owns.Owns( + sources = [ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], + entitlements = [ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], + access_profiles = [ + + ], + roles = [ + + ], + apps = [ + + ], + governance_groups = [ + + ], + fallback_approver = False, ) + ], +owns_count=5, +tags=[TAG_1, TAG_2], +tags_count=56, +visible_segments=[All Employees], +visible_segment_count=1 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..2244b7a91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,36 @@ +--- +id: v2024-identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'V2024IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/python/v2024/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'V2024IdentityDocumentAllOfIdentityProfile'] +--- + +# IdentityDocumentAllOfIdentityProfile + +Identity's identity profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity profile's ID. | [optional] +**name** | **str** | Identity profile's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_document_all_of_identity_profile import IdentityDocumentAllOfIdentityProfile + +identity_document_all_of_identity_profile = IdentityDocumentAllOfIdentityProfile( +id='3bc8ad26b8664945866b31339d1ff7d2', +name='HR Employees' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..afa6e5a7a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocumentAllOfManager', 'V2024IdentityDocumentAllOfManager'] +slug: /tools/sdk/python/v2024/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'V2024IdentityDocumentAllOfManager'] +--- + +# IdentityDocumentAllOfManager + +Identity's manager. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of identity's manager. | [optional] +**name** | **str** | Name of identity's manager. | [optional] +**display_name** | **str** | Display name of identity's manager. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_document_all_of_manager import IdentityDocumentAllOfManager + +identity_document_all_of_manager = IdentityDocumentAllOfManager( +id='2c9180867dfe694b017e208e27c05799', +name='Amanda.Ross', +display_name='Amanda.Ross' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..13651517c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,36 @@ +--- +id: v2024-identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocumentAllOfSource', 'V2024IdentityDocumentAllOfSource'] +slug: /tools/sdk/python/v2024/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'V2024IdentityDocumentAllOfSource'] +--- + +# IdentityDocumentAllOfSource + +Identity's source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of identity's source. | [optional] +**name** | **str** | Display name of identity's source. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_document_all_of_source import IdentityDocumentAllOfSource + +identity_document_all_of_source = IdentityDocumentAllOfSource( +id='2c91808b6e9e6fb8016eec1a2b6f7b5f', +name='ODS-HR-Employees' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityEntities.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityEntities.md new file mode 100644 index 000000000..17db152a7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityEntities.md @@ -0,0 +1,36 @@ +--- +id: v2024-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntities', 'V2024IdentityEntities'] +slug: /tools/sdk/python/v2024/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'V2024IdentityEntities'] +--- + +# IdentityEntities + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_entity** | [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_entities import IdentityEntities + +identity_entities = IdentityEntities( +identity_entity=sailpoint.v2024.models.identity_entities_identity_entity.IdentityEntities_identityEntity( + id = '031034e97f094a4096c1be53f75f6b91', + name = 'Gaston.800ddf9640a', + type = 'CAMPAIGN_CAMPAIGNER', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..9358ed094 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitiesIdentityEntity', 'V2024IdentityEntitiesIdentityEntity'] +slug: /tools/sdk/python/v2024/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'V2024IdentityEntitiesIdentityEntity'] +--- + +# IdentityEntitiesIdentityEntity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the resource to which the identity is associated | [optional] +**name** | **str** | name of the resource to which the identity is associated | [optional] +**type** | **str** | type of the resource to which the identity is associated | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_entities_identity_entity import IdentityEntitiesIdentityEntity + +identity_entities_identity_entity = IdentityEntitiesIdentityEntity( +id='031034e97f094a4096c1be53f75f6b91', +name='Gaston.800ddf9640a', +type='CAMPAIGN_CAMPAIGNER' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..7f4d8822c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityExceptionReportReference.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityExceptionReportReference', 'V2024IdentityExceptionReportReference'] +slug: /tools/sdk/python/v2024/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V2024IdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_result_id** | **str** | Task result ID. | [optional] +**report_name** | **str** | Report name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_exception_report_reference import IdentityExceptionReportReference + +identity_exception_report_reference = IdentityExceptionReportReference( +task_result_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +report_name='My annual report' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityHistoryResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..0f5321d22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityHistoryResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityHistoryResponse', 'V2024IdentityHistoryResponse'] +slug: /tools/sdk/python/v2024/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'V2024IdentityHistoryResponse'] +--- + +# IdentityHistoryResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the identity ID | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**snapshot** | **str** | the date when the identity record was created | [optional] +**deleted_date** | **str** | the date when the identity was deleted | [optional] +**access_item_count** | **map[string]int** | A map containing the count of each access item | [optional] +**attributes** | **map[string]object** | A map containing the identity attributes | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse + +identity_history_response = IdentityHistoryResponse( +id='bc693f07e7b645539626c25954c58554', +display_name='Adam Zampa', +snapshot='2007-03-01T13:00:00.000Z', +deleted_date='2007-03-01T13:00:00.000Z', +access_item_count={app=0, role=2, entitlement=4, accessProfile=3, account=1}, +attributes={jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityLifecycleState.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..eac7a11ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityLifecycleState.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityLifecycleState', 'V2024IdentityLifecycleState'] +slug: /tools/sdk/python/v2024/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'V2024IdentityLifecycleState'] +--- + +# IdentityLifecycleState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state_name** | **str** | The name of the lifecycle state | [required] +**manually_updated** | **bool** | Whether the lifecycle state has been manually or automatically set | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_lifecycle_state import IdentityLifecycleState + +identity_lifecycle_state = IdentityLifecycleState( +state_name='active', +manually_updated=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityListItem.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityListItem.md new file mode 100644 index 000000000..fff6b6e44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityListItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityListItem', 'V2024IdentityListItem'] +slug: /tools/sdk/python/v2024/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'V2024IdentityListItem'] +--- + +# IdentityListItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the identity ID | [optional] +**display_name** | **str** | the display name of the identity | [optional] +**first_name** | **str** | the first name of the identity | [optional] +**last_name** | **str** | the last name of the identity | [optional] +**active** | **bool** | indicates if an identity is active or not | [optional] [default to True] +**deleted_date** | **str** | the date when the identity was deleted | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_list_item import IdentityListItem + +identity_list_item = IdentityListItem( +id='bc693f07e7b645539626c25954c58554', +display_name='Adam Zampa', +first_name='Adam', +last_name='Zampa', +active=True, +deleted_date='2007-03-01T13:00:00.000Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityManagerRef.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityManagerRef.md new file mode 100644 index 000000000..bebe50e94 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityManagerRef.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityManagerRef', 'V2024IdentityManagerRef'] +slug: /tools/sdk/python/v2024/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'V2024IdentityManagerRef'] +--- + +# IdentityManagerRef + +Identity's manager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity's manager | [optional] +**id** | **str** | ID of identity's manager | [optional] +**name** | **str** | Human-readable display name of identity's manager | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_manager_ref import IdentityManagerRef + +identity_manager_ref = IdentityManagerRef( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..b2779285b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityOwnershipAssociationDetails', 'V2024IdentityOwnershipAssociationDetails'] +slug: /tools/sdk/python/v2024/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'V2024IdentityOwnershipAssociationDetails'] +--- + +# IdentityOwnershipAssociationDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**association_details** | [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails + +identity_ownership_association_details = IdentityOwnershipAssociationDetails( +association_details=[ + sailpoint.v2024.models.identity_ownership_association_details_association_details_inner.IdentityOwnershipAssociationDetails_associationDetails_inner( + association_type = 'ROLE_OWNER', + entities = {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE}, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..e711cd0f9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/python/v2024/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + + +## 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_ownership_association_details_association_details_inner import IdentityOwnershipAssociationDetailsAssociationDetailsInner + +identity_ownership_association_details_association_details_inner = IdentityOwnershipAssociationDetailsAssociationDetailsInner( +association_type='ROLE_OWNER', +entities={id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..4a1ec46f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewRequest', 'V2024IdentityPreviewRequest'] +slug: /tools/sdk/python/v2024/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'V2024IdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The Identity id | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_preview_request import IdentityPreviewRequest + +identity_preview_request = IdentityPreviewRequest( +identity_id='', +identity_attribute_config=sailpoint.v2024.models.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/IdentityPreviewResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..c157bbbde --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewResponse.md @@ -0,0 +1,44 @@ +--- +id: v2024-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewResponse', 'V2024IdentityPreviewResponse'] +slug: /tools/sdk/python/v2024/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'V2024IdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**preview_attributes** | [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResponse + +identity_preview_response = IdentityPreviewResponse( +identity=sailpoint.v2024.models.identity_preview_response_identity.IdentityPreviewResponse_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +preview_attributes=[ + sailpoint.v2024.models.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/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..888442f16 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewResponseIdentity', 'V2024IdentityPreviewResponseIdentity'] +slug: /tools/sdk/python/v2024/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'V2024IdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +Identity's basic details. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Identity's DTO type. | [optional] +**id** | **str** | Identity ID. | [optional] +**name** | **str** | Identity's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_preview_response_identity import IdentityPreviewResponseIdentity + +identity_preview_response_identity = IdentityPreviewResponseIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfile.md new file mode 100644 index 000000000..ca2b9b427 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfile.md @@ -0,0 +1,73 @@ +--- +id: v2024-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfile', 'V2024IdentityProfile'] +slug: /tools/sdk/python/v2024/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'V2024IdentityProfile'] +--- + +# IdentityProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | Identity profile's description. | [optional] +**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**priority** | **int** | Identity profile's priority. | [optional] +**authoritative_source** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] +**identity_refresh_required** | **bool** | 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. | [optional] [default to False] +**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**identity_exception_report_reference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.identity_profile import IdentityProfile + +identity_profile = IdentityProfile( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +description='My custom flat file profile', +owner=sailpoint.v2024.models.identity_profile_all_of_owner.IdentityProfile_allOf_owner( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +priority=10, +authoritative_source=sailpoint.v2024.models.identity_profile_all_of_authoritative_source.IdentityProfile_allOf_authoritativeSource( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +identity_refresh_required=True, +identity_count=8, +identity_attribute_config=sailpoint.v2024.models.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}, ), ) + ], ), +identity_exception_report_reference=sailpoint.v2024.models.identity_exception_report_reference.IdentityExceptionReportReference( + task_result_id = '2b838de9-db9b-abcf-e646-d4f274ad4238', + report_name = 'My annual report', ), +has_time_based_attr=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..c77d1ecd4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'V2024IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/python/v2024/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'V2024IdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional] +**id** | **str** | Authoritative source's ID. | [optional] +**name** | **str** | Authoritative source's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_profile_all_of_authoritative_source import IdentityProfileAllOfAuthoritativeSource + +identity_profile_all_of_authoritative_source = IdentityProfileAllOfAuthoritativeSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..16349c91d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileAllOfOwner', 'V2024IdentityProfileAllOfOwner'] +slug: /tools/sdk/python/v2024/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024IdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +Identity profile's owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's object type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_profile_all_of_owner import IdentityProfileAllOfOwner + +identity_profile_all_of_owner = IdentityProfileAllOfOwner( +type='IDENTITY', +id='2c9180835d191a86015d28455b4b232a', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..b8d586057 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileExportedObject.md @@ -0,0 +1,41 @@ +--- +id: v2024-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileExportedObject', 'V2024IdentityProfileExportedObject'] +slug: /tools/sdk/python/v2024/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'V2024IdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +Identity profile exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Version or object from the target service. | [optional] +**var_self** | [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**object** | [**IdentityProfile**](identity-profile) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_profile_exported_object import IdentityProfileExportedObject + +identity_profile_exported_object = IdentityProfileExportedObject( +version=1, +var_self=sailpoint.v2024.models.identity_profile_exported_object_self.IdentityProfileExportedObject_self( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +object= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..2f72087a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileExportedObjectSelf', 'V2024IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/python/v2024/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'V2024IdentityProfileExportedObjectSelf'] +--- + +# IdentityProfileExportedObjectSelf + +Self block for exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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' ] | Exported object's DTO type. | [optional] +**id** | **str** | Exported object's ID. | [optional] +**name** | **str** | Exported object's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_profile_exported_object_self import IdentityProfileExportedObjectSelf + +identity_profile_exported_object_self = IdentityProfileExportedObjectSelf( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..b434aa02f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,34 @@ +--- +id: v2024-identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'V2024IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/python/v2024/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'V2024IdentityProfileIdentityErrorReportArguments'] +--- + +# IdentityProfileIdentityErrorReportArguments + +Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authoritative_source** | **str** | Source ID. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_profile_identity_error_report_arguments import IdentityProfileIdentityErrorReportArguments + +identity_profile_identity_error_report_arguments = IdentityProfileIdentityErrorReportArguments( +authoritative_source='1234sourceId5678902' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityReference.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityReference.md new file mode 100644 index 000000000..3e011e0d8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityReference.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReference', 'V2024IdentityReference'] +slug: /tools/sdk/python/v2024/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'V2024IdentityReference'] +--- + +# IdentityReference + +The manager for the identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_reference import IdentityReference + +identity_reference = IdentityReference( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..7ea98683e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReferenceWithNameAndEmail', 'V2024IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/python/v2024/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'V2024IdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type can only be IDENTITY. This is read-only. | [optional] +**id** | **str** | Identity ID. | [optional] +**name** | **str** | Identity's human-readable display name. This is read-only. | [optional] +**email** | **str** | Identity's email address. This is read-only. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail + +identity_reference_with_name_and_email = IdentityReferenceWithNameAndEmail( +type='IDENTITY', +id='5168015d32f890ca15812c9180835d2e', +name='Alison Ferguso', +email='alison.ferguso@identitysoon.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..ac2a00368 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,33 @@ +--- +id: v2024-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySnapshotSummaryResponse', 'V2024IdentitySnapshotSummaryResponse'] +slug: /tools/sdk/python/v2024/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'V2024IdentitySnapshotSummaryResponse'] +--- + +# IdentitySnapshotSummaryResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**snapshot** | **str** | the date when the identity record was created | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse + +identity_snapshot_summary_response = IdentitySnapshotSummaryResponse( +snapshot='2007-03-01T13:00:00.000Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitySummary.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySummary.md new file mode 100644 index 000000000..7f7e61f0a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySummary.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySummary', 'V2024IdentitySummary'] +slug: /tools/sdk/python/v2024/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'V2024IdentitySummary'] +--- + +# IdentitySummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of this identity summary | [optional] +**name** | **str** | Human-readable display name of identity | [optional] +**identity_id** | **str** | ID of the identity that this summary represents | [optional] +**completed** | **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.identity_summary import IdentitySummary + +identity_summary = IdentitySummary( +id='ff80818155fe8c080155fe8d925b0316', +name='SailPoint Services', +identity_id='c15b9f5cca5a4e9599eaa0e64fa921bd', +completed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitySyncJob.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySyncJob.md new file mode 100644 index 000000000..c6ab2a239 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySyncJob.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySyncJob', 'V2024IdentitySyncJob'] +slug: /tools/sdk/python/v2024/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'V2024IdentitySyncJob'] +--- + +# IdentitySyncJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Job ID. | [required] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The job status. | [required] +**payload** | [**IdentitySyncPayload**](identity-sync-payload) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_sync_job import IdentitySyncJob + +identity_sync_job = IdentitySyncJob( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +status='IN_PROGRESS', +payload=sailpoint.v2024.models.identity_sync_payload.IdentitySyncPayload( + type = 'SYNCHRONIZE_IDENTITY_ATTRIBUTES', + data_json = '{"identityId":"2c918083746f642c01746f990884012a"}', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitySyncPayload.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..5308e0e11 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitySyncPayload.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySyncPayload', 'V2024IdentitySyncPayload'] +slug: /tools/sdk/python/v2024/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'V2024IdentitySyncPayload'] +--- + +# IdentitySyncPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Payload type. | [required] +**data_json** | **str** | Payload type. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_sync_payload import IdentitySyncPayload + +identity_sync_payload = IdentitySyncPayload( +type='SYNCHRONIZE_IDENTITY_ATTRIBUTES', +data_json='{"identityId":"2c918083746f642c01746f990884012a"}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..e75aa211c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md @@ -0,0 +1,36 @@ +--- +id: v2024-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess', 'V2024IdentityWithNewAccess'] +slug: /tools/sdk/python/v2024/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'V2024IdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +An identity with a set of access to be added + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity id to be checked. | [required] +**access_refs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess + +identity_with_new_access = IdentityWithNewAccess( +identity_id='2c91808568c529c60168cca6f90c1313', +access_refs=[{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}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..b68ab640a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess1.md @@ -0,0 +1,40 @@ +--- +id: v2024-identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] +slug: /tools/sdk/python/v2024/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] +--- + +# IdentityWithNewAccess1 + +An identity with a set of access to be added + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Set of identity IDs to be checked. | [required] +**access_refs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] +**client_metadata** | **map[string]str** | 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_with_new_access1 import IdentityWithNewAccess1 + +identity_with_new_access1 = IdentityWithNewAccess1( +identity_id='2c91809050db617d0150e0bf3215385e', +access_refs=[ + null + ], +client_metadata={clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..a14755812 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'V2024IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/python/v2024/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'V2024IdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +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.identity_with_new_access_access_refs_inner import IdentityWithNewAccessAccessRefsInner + +identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( +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/ImportAccountsRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..78657203e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportAccountsRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportAccountsRequest', 'V2024ImportAccountsRequest'] +slug: /tools/sdk/python/v2024/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'V2024ImportAccountsRequest'] +--- + +# ImportAccountsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | The CSV file containing the source accounts to aggregate. | [optional] +**disable_optimization** | **str** | Use this flag to reprocess every account whether or not the data has changed. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.import_accounts_request import ImportAccountsRequest + +import_accounts_request = ImportAccountsRequest( +file=bytes(b'blah'), +disable_optimization='true' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..199f0c941 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportEntitlementsBySourceRequest', 'V2024ImportEntitlementsBySourceRequest'] +slug: /tools/sdk/python/v2024/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'V2024ImportEntitlementsBySourceRequest'] +--- + +# ImportEntitlementsBySourceRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**csv_file** | **bytearray** | The CSV file containing the source entitlements to aggregate. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.import_entitlements_by_source_request import ImportEntitlementsBySourceRequest + +import_entitlements_by_source_request = ImportEntitlementsBySourceRequest( +csv_file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..b867badb2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,117 @@ +--- +id: v2024-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportFormDefinitions202Response', 'V2024ImportFormDefinitions202Response'] +slug: /tools/sdk/python/v2024/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'V2024ImportFormDefinitions202Response'] +--- + +# ImportFormDefinitions202Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**imported_objects** | [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional] +**infos** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**warnings** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.import_form_definitions202_response import ImportFormDefinitions202Response + +import_form_definitions202_response = ImportFormDefinitions202Response( +errors=[ + sailpoint.v2024.models.import_form_definitions_202_response_errors_inner.importFormDefinitions_202_response_errors_inner( + detail = { + 'key' : None + }, + key = '', + text = '', ) + ], +imported_objects=[ + sailpoint.v2024.models.export_form_definitions_by_tenant_200_response_inner.exportFormDefinitionsByTenant_200_response_inner( + 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', ), + self = '', + version = 56, ) + ], +infos=[ + sailpoint.v2024.models.import_form_definitions_202_response_errors_inner.importFormDefinitions_202_response_errors_inner( + detail = { + 'key' : None + }, + key = '', + text = '', ) + ], +warnings=[ + sailpoint.v2024.models.import_form_definitions_202_response_errors_inner.importFormDefinitions_202_response_errors_inner( + detail = { + 'key' : None + }, + key = '', + text = '', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..7441822df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'V2024ImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/python/v2024/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'V2024ImportFormDefinitions202ResponseErrorsInner'] +--- + +# ImportFormDefinitions202ResponseErrorsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | **map[string]object** | | [optional] +**key** | **str** | | [optional] +**text** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.import_form_definitions202_response_errors_inner import ImportFormDefinitions202ResponseErrorsInner + +import_form_definitions202_response_errors_inner = ImportFormDefinitions202ResponseErrorsInner( +detail={ + 'key' : None + }, +key='', +text='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..029e6f6f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'V2024ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/python/v2024/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'V2024ImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.import_non_employee_records_in_bulk_request import ImportNonEmployeeRecordsInBulkRequest + +import_non_employee_records_in_bulk_request = ImportNonEmployeeRecordsInBulkRequest( +data=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportObject.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportObject.md new file mode 100644 index 000000000..78c8cdf19 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportObject.md @@ -0,0 +1,38 @@ +--- +id: v2024-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportObject', 'V2024ImportObject'] +slug: /tools/sdk/python/v2024/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'V2024ImportObject'] +--- + +# ImportObject + +Object created or updated by import. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_RULE', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional] +**id** | **str** | ID of object created or updated by import. | [optional] +**name** | **str** | Display name of object created or updated by import. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.import_object import ImportObject + +import_object = ImportObject( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportOptions.md new file mode 100644 index 000000000..de30ae738 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportOptions.md @@ -0,0 +1,47 @@ +--- +id: v2024-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportOptions', 'V2024ImportOptions'] +slug: /tools/sdk/python/v2024/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'V2024ImportOptions'] +--- + +# ImportOptions + + +## 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] +**default_references** | **[]str** | List of object types that can be used to resolve references on import. | [optional] +**exclude_backup** | **bool** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.import_options import ImportOptions + +import_options = ImportOptions( +exclude_types=[ + 'SOURCE' + ], +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}, +default_references=[ + 'TRIGGER_SUBSCRIPTION' + ], +exclude_backup=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ImportSpConfigRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..0072b75c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ImportSpConfigRequest.md @@ -0,0 +1,46 @@ +--- +id: v2024-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportSpConfigRequest', 'V2024ImportSpConfigRequest'] +slug: /tools/sdk/python/v2024/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'V2024ImportSpConfigRequest'] +--- + +# ImportSpConfigRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | JSON file containing the objects to be imported. | [required] +**options** | [**ImportOptions**](import-options) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.import_sp_config_request import ImportSpConfigRequest + +import_sp_config_request = ImportSpConfigRequest( +data=bytes(b'blah'), +options=sailpoint.v2024.models.import_options.ImportOptions( + exclude_types = [ + 'SOURCE' + ], + include_types = [ + 'TRIGGER_SUBSCRIPTION' + ], + object_options = {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}, + default_references = [ + 'TRIGGER_SUBSCRIPTION' + ], + exclude_backup = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Index.md b/docs/tools/sdk/python/Reference/V2024/Models/Index.md new file mode 100644 index 000000000..a43717744 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['python', 'Python', 'sdk', 'models'] +slug: /tools/sdk/python/v2024/models +tags: ['SDK', 'Software Development Kit', 'v2024', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Indices.md b/docs/tools/sdk/python/Reference/V2024/Models/Indices.md new file mode 100644 index 000000000..147e7ea89 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Indices.md @@ -0,0 +1,33 @@ +--- +id: v2024-index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Index', 'V2024Index'] +slug: /tools/sdk/python/v2024/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'V2024Index'] +--- + +# Index + +Enum representing the currently supported indices. Additional values may be added in the future without notice. + +## Enum + +* `ACCESSPROFILES` (value: `'accessprofiles'`) + +* `ACCOUNTACTIVITIES` (value: `'accountactivities'`) + +* `ENTITLEMENTS` (value: `'entitlements'`) + +* `EVENTS` (value: `'events'`) + +* `IDENTITIES` (value: `'identities'`) + +* `ROLES` (value: `'roles'`) + +* `STAR` (value: `'*'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/InnerHit.md b/docs/tools/sdk/python/Reference/V2024/Models/InnerHit.md new file mode 100644 index 000000000..c5ea1693c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/InnerHit.md @@ -0,0 +1,36 @@ +--- +id: v2024-inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InnerHit', 'V2024InnerHit'] +slug: /tools/sdk/python/v2024/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'V2024InnerHit'] +--- + +# InnerHit + +Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | 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. | [required] +**type** | **str** | 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. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.inner_hit import InnerHit + +inner_hit = InnerHit( +query='source.name:\"Active Directory\"', +type='access' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..7b9ead8ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/InviteIdentitiesRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InviteIdentitiesRequest', 'V2024InviteIdentitiesRequest'] +slug: /tools/sdk/python/v2024/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'V2024InviteIdentitiesRequest'] +--- + +# InviteIdentitiesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**uninvited** | **bool** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.invite_identities_request import InviteIdentitiesRequest + +invite_identities_request = InviteIdentitiesRequest( +ids=[2b568c65bc3c4c57a43bd97e3a8e55, 2c9180867769897d01776ed5f125512f], +uninvited=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Invocation.md b/docs/tools/sdk/python/Reference/V2024/Models/Invocation.md new file mode 100644 index 000000000..eb863ce91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Invocation.md @@ -0,0 +1,39 @@ +--- +id: v2024-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Invocation', 'V2024Invocation'] +slug: /tools/sdk/python/v2024/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'V2024Invocation'] +--- + +# Invocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Invocation ID | [optional] +**trigger_id** | **str** | Trigger ID | [optional] +**secret** | **str** | Unique invocation secret. | [optional] +**content_json** | **object** | JSON map of invocation metadata. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.invocation import Invocation + +invocation = Invocation( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +trigger_id='idn:access-requested', +secret='0f979022-08be-44f2-b6f9-7393ec73ed9b', +content_json={workflowId=1234} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/InvocationStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/InvocationStatus.md new file mode 100644 index 000000000..5c6299b50 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/InvocationStatus.md @@ -0,0 +1,56 @@ +--- +id: v2024-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InvocationStatus', 'V2024InvocationStatus'] +slug: /tools/sdk/python/v2024/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'V2024InvocationStatus'] +--- + +# InvocationStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Invocation ID | [required] +**trigger_id** | **str** | Trigger ID | [required] +**subscription_name** | **str** | Subscription name | [required] +**subscription_id** | **str** | Subscription ID | [required] +**type** | [**InvocationStatusType**](invocation-status-type) | | [required] +**created** | **datetime** | Invocation created timestamp. ISO-8601 in UTC. | [required] +**completed** | **datetime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**start_invocation_input** | [**StartInvocationInput**](start-invocation-input) | | [required] +**complete_invocation_input** | [**CompleteInvocationInput**](complete-invocation-input) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.invocation_status import InvocationStatus + +invocation_status = InvocationStatus( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +trigger_id='idn:access-request-post-approval', +subscription_name='Access request subscription', +subscription_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +type='TEST', +created='2020-03-27T20:40:10.738Z', +completed='2020-03-27T20:42:14.738Z', +start_invocation_input=sailpoint.v2024.models.start_invocation_input.StartInvocationInput( + trigger_id = 'idn:access-requested', + input = {identityId=201327fda1c44704ac01181e963d463c}, + content_json = {workflowId=1234}, ), +complete_invocation_input=sailpoint.v2024.models.complete_invocation_input.CompleteInvocationInput( + localized_error = sailpoint.v2024.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), + output = {approved=false}, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/InvocationStatusType.md b/docs/tools/sdk/python/Reference/V2024/Models/InvocationStatusType.md new file mode 100644 index 000000000..8300f06ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/InvocationStatusType.md @@ -0,0 +1,23 @@ +--- +id: v2024-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InvocationStatusType', 'V2024InvocationStatusType'] +slug: /tools/sdk/python/v2024/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'V2024InvocationStatusType'] +--- + +# InvocationStatusType + +Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. + +## Enum + +* `TEST` (value: `'TEST'`) + +* `REAL_TIME` (value: `'REAL_TIME'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/JsonPatch.md b/docs/tools/sdk/python/Reference/V2024/Models/JsonPatch.md new file mode 100644 index 000000000..e6b5d9642 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/JsonPatch.md @@ -0,0 +1,39 @@ +--- +id: v2024-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatch', 'V2024JsonPatch'] +slug: /tools/sdk/python/v2024/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'V2024JsonPatch'] +--- + +# JsonPatch + +A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.json_patch import JsonPatch + +json_patch = JsonPatch( +operations=[ + sailpoint.v2024.models.json_patch_operation.JsonPatchOperation( + op = 'replace', + path = '/description', + value = New description, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperation.md new file mode 100644 index 000000000..6a9893c19 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperation.md @@ -0,0 +1,38 @@ +--- +id: v2024-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperation', 'V2024JsonPatchOperation'] +slug: /tools/sdk/python/v2024/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'V2024JsonPatchOperation'] +--- + +# JsonPatchOperation + +A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy', 'test' ] | The operation to be performed | [required] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + +json_patch_operation = JsonPatchOperation( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperationValue.md b/docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperationValue.md new file mode 100644 index 000000000..8369a5012 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperationValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-json-patch-operation-value +title: JsonPatchOperationValue +pagination_label: JsonPatchOperationValue +sidebar_label: JsonPatchOperationValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue'] +slug: /tools/sdk/python/v2024/models/json-patch-operation-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue'] +--- + +# JsonPatchOperationValue + +The value to be used for the operation, required for \"add\" and \"replace\" operations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.json_patch_operation_value import JsonPatchOperationValue + +json_patch_operation_value = JsonPatchOperationValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/python/Reference/V2024/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..1346b713d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/KbaAnswerRequestItem.md @@ -0,0 +1,35 @@ +--- +id: v2024-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAnswerRequestItem', 'V2024KbaAnswerRequestItem'] +slug: /tools/sdk/python/v2024/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'V2024KbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Question Id | [required] +**answer** | **str** | An answer for the KBA question | [required] +} + +## Example + +```python +from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem + +kba_answer_request_item = KbaAnswerRequestItem( +id='c54fee53-2d63-4fc5-9259-3e93b9994135', +answer='Your answer' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/python/Reference/V2024/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..858c85970 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/KbaAnswerResponseItem.md @@ -0,0 +1,37 @@ +--- +id: v2024-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAnswerResponseItem', 'V2024KbaAnswerResponseItem'] +slug: /tools/sdk/python/v2024/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'V2024KbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Question Id | [required] +**question** | **str** | Question description | [required] +**has_answer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | [required] +} + +## Example + +```python +from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem + +kba_answer_response_item = KbaAnswerResponseItem( +id='c54fee53-2d63-4fc5-9259-3e93b9994135', +question='[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]', +has_answer=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/KbaQuestion.md b/docs/tools/sdk/python/Reference/V2024/Models/KbaQuestion.md new file mode 100644 index 000000000..52b7c2a4e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/KbaQuestion.md @@ -0,0 +1,40 @@ +--- +id: v2024-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaQuestion', 'V2024KbaQuestion'] +slug: /tools/sdk/python/v2024/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'V2024KbaQuestion'] +--- + +# KbaQuestion + +KBA Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | KBA Question Id | [required] +**text** | **str** | KBA Question description | [required] +**has_answer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] +**num_answers** | **int** | Denotes the number of KBA configurations for this question | [required] +} + +## Example + +```python +from sailpoint.v2024.models.kba_question import KbaQuestion + +kba_question = KbaQuestion( +id='143cfd3b-c23f-426b-ae5f-d3db06fa5919', +text='[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]', +has_answer=True, +num_answers=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LatestOutlierSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..0a6a17da0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LatestOutlierSummary.md @@ -0,0 +1,41 @@ +--- +id: v2024-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LatestOutlierSummary', 'V2024LatestOutlierSummary'] +slug: /tools/sdk/python/v2024/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'V2024LatestOutlierSummary'] +--- + +# LatestOutlierSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LOW_SIMILARITY', 'STRUCTURAL' ] | The type of outlier summary | [optional] +**snapshot_date** | **datetime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**total_outliers** | **int** | Total number of outliers for the customer making the request | [optional] +**total_identities** | **int** | Total number of identities for the customer making the request | [optional] +**total_ignored** | **int** | Total number of ignored outliers | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.latest_outlier_summary import LatestOutlierSummary + +latest_outlier_summary = LatestOutlierSummary( +type='LOW_SIMILARITY', +snapshot_date='2021-05-01T18:40:35.772Z', +total_outliers=50, +total_identities=5000, +total_ignored=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/License.md b/docs/tools/sdk/python/Reference/V2024/Models/License.md new file mode 100644 index 000000000..c1e81d351 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/License.md @@ -0,0 +1,35 @@ +--- +id: v2024-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'License', 'V2024License'] +slug: /tools/sdk/python/v2024/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'V2024License'] +--- + +# License + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**license_id** | **str** | Name of the license | [optional] +**legacy_feature_name** | **str** | Legacy name of the license | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.license import License + +license = License( +license_id='idn:access-request', +legacy_feature_name='ACCESS_REQUEST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LifecycleState.md b/docs/tools/sdk/python/Reference/V2024/Models/LifecycleState.md new file mode 100644 index 000000000..6a6d3fe43 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LifecycleState.md @@ -0,0 +1,63 @@ +--- +id: v2024-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecycleState', 'V2024LifecycleState'] +slug: /tools/sdk/python/v2024/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'V2024LifecycleState'] +--- + +# LifecycleState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**enabled** | **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to False] +**technical_name** | **str** | The lifecycle state's technical name. This is for internal use. | [required] +**description** | **str** | Lifecycle state's description. | [optional] +**identity_count** | **int** | Number of identities that have the lifecycle state. | [optional] [readonly] +**email_notification_option** | [**EmailNotificationOption**](email-notification-option) | | [optional] +**account_actions** | [**[]AccountAction**](account-action) | | [optional] +**access_profile_ids** | **[]str** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional] +**identity_state** | **str** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.lifecycle_state import LifecycleState + +lifecycle_state = LifecycleState( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +enabled=True, +technical_name='Technical Name', +description='Lifecycle description', +identity_count=42, +email_notification_option=sailpoint.v2024.models.email_notification_option.EmailNotificationOption( + notify_managers = True, + notify_all_admins = True, + notify_specific_users = True, + email_address_list = [test@test.com, test2@test.com], ), +account_actions=[ + sailpoint.v2024.models.account_action.AccountAction( + action = 'ENABLE', + source_ids = [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], ) + ], +access_profile_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], +identity_state='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LifecycleStateDto.md b/docs/tools/sdk/python/Reference/V2024/Models/LifecycleStateDto.md new file mode 100644 index 000000000..bb7a40622 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LifecycleStateDto.md @@ -0,0 +1,35 @@ +--- +id: v2024-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecycleStateDto', 'V2024LifecycleStateDto'] +slug: /tools/sdk/python/v2024/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'V2024LifecycleStateDto'] +--- + +# LifecycleStateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state_name** | **str** | The name of the lifecycle state | [required] +**manually_updated** | **bool** | Whether the lifecycle state has been manually or automatically set | [required] +} + +## Example + +```python +from sailpoint.v2024.models.lifecycle_state_dto import LifecycleStateDto + +lifecycle_state_dto = LifecycleStateDto( +state_name='active', +manually_updated=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md b/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..59cd10f2e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md @@ -0,0 +1,38 @@ +--- +id: v2024-lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecyclestateDeleted', 'V2024LifecyclestateDeleted'] +slug: /tools/sdk/python/v2024/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2024LifecyclestateDeleted'] +--- + +# LifecyclestateDeleted + +Deleted lifecycle state. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIFECYCLE_STATE' ] | Deleted lifecycle state's DTO type. | [optional] +**id** | **str** | Deleted lifecycle state ID. | [optional] +**name** | **str** | Deleted lifecycle state's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.lifecyclestate_deleted import LifecyclestateDeleted + +lifecyclestate_deleted = LifecyclestateDeleted( +type='LIFECYCLE_STATE', +id='12345', +name='Contractor Lifecycle' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/python/Reference/V2024/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..6b463c0d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListAccessProfiles401Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListAccessProfiles401Response', 'V2024ListAccessProfiles401Response'] +slug: /tools/sdk/python/v2024/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'V2024ListAccessProfiles401Response'] +--- + +# ListAccessProfiles401Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_access_profiles401_response import ListAccessProfiles401Response + +list_access_profiles401_response = ListAccessProfiles401Response( +error=JWT validation failed: JWT is expired +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/python/Reference/V2024/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..3859a295f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListAccessProfiles429Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListAccessProfiles429Response', 'V2024ListAccessProfiles429Response'] +slug: /tools/sdk/python/v2024/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'V2024ListAccessProfiles429Response'] +--- + +# ListAccessProfiles429Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_access_profiles429_response import ListAccessProfiles429Response + +list_access_profiles429_response = ListAccessProfiles429Response( +message= Rate Limit Exceeded +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..829677f63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListCampaignFilters200Response.md @@ -0,0 +1,44 @@ +--- +id: v2024-list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListCampaignFilters200Response', 'V2024ListCampaignFilters200Response'] +slug: /tools/sdk/python/v2024/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'V2024ListCampaignFilters200Response'] +--- + +# ListCampaignFilters200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**count** | **int** | Number of filters returned. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_campaign_filters200_response import ListCampaignFilters200Response + +list_campaign_filters200_response = ListCampaignFilters200Response( +items=[ + sailpoint.v2024.models.campaign_filter_details.CampaignFilterDetails( + id = '5ec18cef39020d6fd7a60ad3970aba61', + name = 'Identity Attribute Campaign Filter', + description = 'Campaign filter to certify data based on an identity attribute's specified property.', + owner = 'SailPoint Support', + mode = INCLUSION, + criteria_list = [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}], + is_system_filter = False, ) + ], +count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..212d067a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,57 @@ +--- +id: v2024-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2024ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/python/v2024/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2024ListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Operator ID. | [optional] +**name** | **str** | Operator friendly name | [optional] +**type** | **str** | Operator type | [optional] +**description** | **str** | Description of the operator | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**example_output** | [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**version_number** | **int** | Version number | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**output_schema** | **object** | Example output schema | [optional] +**input_example** | **object** | Example trigger payload if applicable | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + +list_complete_workflow_library200_response_inner = ListCompleteWorkflowLibrary200ResponseInner( +id='sp:compare-boolean', +name='Compare Boolean Values', +type='OPERATOR', +description='Compare two boolean values and decide what happens based on the result.', +form_fields=[{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}], +example_output=, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +version_number=56, +is_simulation_enabled=True, +is_dynamic_schema=False, +output_schema=sailpoint.v2024.models.output_schema.outputSchema(), +input_example={changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListDeploys200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/ListDeploys200Response.md new file mode 100644 index 000000000..6c2c76489 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListDeploys200Response.md @@ -0,0 +1,47 @@ +--- +id: v2024-list-deploys200-response +title: ListDeploys200Response +pagination_label: ListDeploys200Response +sidebar_label: ListDeploys200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListDeploys200Response', 'V2024ListDeploys200Response'] +slug: /tools/sdk/python/v2024/models/list-deploys200-response +tags: ['SDK', 'Software Development Kit', 'ListDeploys200Response', 'V2024ListDeploys200Response'] +--- + +# ListDeploys200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[]DeployResponse**](deploy-response) | list of deployments | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response + +list_deploys200_response = ListDeploys200Response( +items=[ + sailpoint.v2024.models.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/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..dd6e38ab4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,89 @@ +--- +id: v2024-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListFormDefinitionsByTenantResponse', 'V2024ListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/python/v2024/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'V2024ListFormDefinitionsByTenantResponse'] +--- + +# ListFormDefinitionsByTenantResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Count number of results. | [optional] +**results** | [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse + +list_form_definitions_by_tenant_response = ListFormDefinitionsByTenantResponse( +count=1, +results=[ + 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', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..7a63d48e9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,33 @@ +--- +id: v2024-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListFormElementDataByElementIDResponse', 'V2024ListFormElementDataByElementIDResponse'] +slug: /tools/sdk/python/v2024/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'V2024ListFormElementDataByElementIDResponse'] +--- + +# ListFormElementDataByElementIDResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse + +list_form_element_data_by_element_id_response = ListFormElementDataByElementIDResponse( +results={"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"}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md new file mode 100644 index 000000000..d7a1c0d1e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md @@ -0,0 +1,95 @@ +--- +id: v2024-list-form-instances-by-tenant-response +title: ListFormInstancesByTenantResponse +pagination_label: ListFormInstancesByTenantResponse +sidebar_label: ListFormInstancesByTenantResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListFormInstancesByTenantResponse', 'V2024ListFormInstancesByTenantResponse'] +slug: /tools/sdk/python/v2024/models/list-form-instances-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormInstancesByTenantResponse', 'V2024ListFormInstancesByTenantResponse'] +--- + +# ListFormInstancesByTenantResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Count number of Results | [optional] +**results** | [**[]FormInstanceResponse**](form-instance-response) | Results holds a list of FormInstanceResponse items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse + +list_form_instances_by_tenant_response = ListFormInstancesByTenantResponse( +count=1, +results=[ + sailpoint.v2024.models.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', + 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/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..fa933367c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,69 @@ +--- +id: v2024-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'V2024ListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/python/v2024/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'V2024ListIdentityAccessItems200ResponseInner'] +--- + +# ListIdentityAccessItems200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_type** | **str** | the access item type. role in this case | [optional] +**id** | **str** | the access item id | [optional] +**name** | **str** | the access profile name | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**source_id** | **str** | the id of the source | [optional] +**description** | **str** | the description for the role | [optional] +**display_name** | **str** | the role display name | [optional] +**entitlement_count** | **str** | the number of entitlements the account will create | [optional] +**app_display_name** | **str** | the name of | [optional] +**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional] +**standalone** | **bool** | indicates whether the entitlement is standalone | [required] +**revocable** | **bool** | indicates whether the role is revocable | [required] +**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] +**app_role_id** | **str** | the app role id | [optional] +**attribute** | **str** | the entitlement attribute | [optional] +**value** | **str** | the associated value | [optional] +**entitlement_type** | **str** | the type of entitlement | [optional] +**privileged** | **bool** | indicates whether the entitlement is privileged | [required] +**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required] +} + +## Example + +```python +from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner + +list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner( +access_type='role', +id='2c918087763e69d901763e72e97f006f', +name='sample', +source_name='Source Name', +source_id='2793o32dwd', +description='Role - Workday/Citizenship access', +display_name='sample', +entitlement_count='12', +app_display_name='AppName', +remove_date='2024-07-01T06:00:00.00Z', +standalone=True, +revocable=True, +native_identity='dr.arden.ogahn.d', +app_role_id='2c918087763e69d901763e72e97f006f', +attribute='groups', +value='Upward mobility access', +entitlement_type='entitlement', +privileged=False, +cloud_governed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..64de9dd45 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListPredefinedSelectOptionsResponse', 'V2024ListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/python/v2024/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'V2024ListPredefinedSelectOptionsResponse'] +--- + +# ListPredefinedSelectOptionsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | **[]str** | Results holds a list of PreDefinedSelectOption items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse + +list_predefined_select_options_response = ListPredefinedSelectOptionsResponse( +results=[ + 'IDENTITY' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..3d596b9d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,40 @@ +--- +id: v2024-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'V2024ListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/python/v2024/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'V2024ListWorkgroupMembers200ResponseInner'] +--- + +# ListWorkgroupMembers200ResponseInner + +Identity of workgroup member. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Workgroup member identity DTO type. | [optional] +**id** | **str** | Workgroup member identity ID. | [optional] +**name** | **str** | Workgroup member identity display name. | [optional] +**email** | **str** | Workgroup member identity email. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner + +list_workgroup_members200_response_inner = ListWorkgroupMembers200ResponseInner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels', +email='michael.michaels@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTask.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTask.md new file mode 100644 index 000000000..1899b2f8e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTask.md @@ -0,0 +1,53 @@ +--- +id: v2024-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTask', 'V2024LoadAccountsTask'] +slug: /tools/sdk/python/v2024/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'V2024LoadAccountsTask'] +--- + +# LoadAccountsTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | The status of the result | [optional] [default to True] +**task** | [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_accounts_task import LoadAccountsTask + +load_accounts_task = LoadAccountsTask( +success=True, +task=sailpoint.v2024.models.load_accounts_task_task.LoadAccountsTask_task( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'QUARTZ', + name = 'Cloud Account Aggregation', + description = 'Aggregate from the specified application', + launcher = 'John Doe', + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + launched = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completed = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completion_status = 'Success', + parent_name = 'Audit Report', + messages = [], + progress = 'Initializing...', + attributes = { + 'key' : None + }, + returns = [ + [{displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED, attributeName=optimizedAggregation}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IGNORED, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED, attributeName=groupsCreated}] + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..0499e0576 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTask.md @@ -0,0 +1,63 @@ +--- +id: v2024-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTask', 'V2024LoadAccountsTaskTask'] +slug: /tools/sdk/python/v2024/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'V2024LoadAccountsTaskTask'] +--- + +# LoadAccountsTaskTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this taskStatus represents | [optional] +**type** | **str** | Type of task this task represents | [optional] +**name** | **str** | The name of the aggregation process | [optional] +**description** | **str** | The description of the task | [optional] +**launcher** | **str** | The user who initiated the task | [optional] +**created** | **datetime** | The Task creation date | [optional] +**launched** | **datetime** | The task start date | [optional] +**completed** | **datetime** | The task completion date | [optional] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Task completion status. | [optional] +**parent_name** | **str** | Name of the parent task if exists. | [optional] +**messages** | [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**progress** | **str** | Current task state. | [optional] +**attributes** | [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**returns** | [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_accounts_task_task import LoadAccountsTaskTask + +load_accounts_task_task = LoadAccountsTaskTask( +id='ef38f94347e94562b5bb8424a56397d8', +type='QUARTZ', +name='Cloud Account Aggregation', +description='Aggregate from the specified application', +launcher='John Doe', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success', +parent_name='Audit Report', +messages=[], +progress='Initializing...', +attributes={ + 'key' : None + }, +returns=[ + [{displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_OPTIMIZED, attributeName=optimizedAggregation}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IGNORED, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_AGGREGATION_GROUPS_CREATED, attributeName=groupsCreated}] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..20b123a6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,36 @@ +--- +id: v2024-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTaskAttributes', 'V2024LoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/python/v2024/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'V2024LoadAccountsTaskTaskAttributes'] +--- + +# LoadAccountsTaskTaskAttributes + +Extra attributes map(dictionary) for the task. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_id** | **str** | The id of the source | [optional] +**optimized_aggregation** | **str** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_accounts_task_task_attributes import LoadAccountsTaskTaskAttributes + +load_accounts_task_task_attributes = LoadAccountsTaskTaskAttributes( +app_id='c31386cb18bb403cbb6df4c86294ff82', +optimized_aggregation='enabled' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..f262dc486 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'V2024LoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/python/v2024/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'V2024LoadAccountsTaskTaskMessagesInner'] +--- + +# LoadAccountsTaskTaskMessagesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message. | [optional] +**error** | **bool** | Flag whether message is an error. | [optional] [default to False] +**warning** | **bool** | Flag whether message is a warning. | [optional] [default to False] +**key** | **str** | Message string identifier. | [optional] +**localized_text** | **str** | Message context with the locale based language. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_accounts_task_task_messages_inner import LoadAccountsTaskTaskMessagesInner + +load_accounts_task_task_messages_inner = LoadAccountsTaskTaskMessagesInner( +type='WARN', +error=False, +warning=True, +key='This aggregation failed because the currently running aggregation must complete before the next one can start.', +localized_text='This aggregation failed because the currently running aggregation must complete before the next one can start.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..2301d11a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'V2024LoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/python/v2024/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'V2024LoadAccountsTaskTaskReturnsInner'] +--- + +# LoadAccountsTaskTaskReturnsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_label** | **str** | The display label of the return value | [optional] +**attribute_name** | **str** | The attribute name of the return value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_accounts_task_task_returns_inner import LoadAccountsTaskTaskReturnsInner + +load_accounts_task_task_returns_inner = LoadAccountsTaskTaskReturnsInner( +display_label='TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS', +attribute_name='applications' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadEntitlementTask.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..2beabb918 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadEntitlementTask.md @@ -0,0 +1,45 @@ +--- +id: v2024-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadEntitlementTask', 'V2024LoadEntitlementTask'] +slug: /tools/sdk/python/v2024/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'V2024LoadEntitlementTask'] +--- + +# LoadEntitlementTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this taskStatus represents | [optional] +**type** | **str** | Type of task this task represents | [optional] +**unique_name** | **str** | The name of the task | [optional] +**description** | **str** | The description of the task | [optional] +**launcher** | **str** | The user who initiated the task | [optional] +**created** | **datetime** | The creation date of the task | [optional] +**returns** | [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask + +load_entitlement_task = LoadEntitlementTask( +id='ef38f94347e94562b5bb8424a56397d8', +type='QUARTZ', +unique_name='Cloud Group Aggregation', +description='Aggregate from the specified application', +launcher='John Doe', +created='2020-07-11T21:23:15Z', +returns=[{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..4b0217af0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadEntitlementTaskReturnsInner', 'V2024LoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/python/v2024/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'V2024LoadEntitlementTaskReturnsInner'] +--- + +# LoadEntitlementTaskReturnsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_label** | **str** | The display label for the return value | [optional] +**attribute_name** | **str** | The attribute name for the return value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_entitlement_task_returns_inner import LoadEntitlementTaskReturnsInner + +load_entitlement_task_returns_inner = LoadEntitlementTaskReturnsInner( +display_label='TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS', +attribute_name='applications' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..d5dbb6c72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,51 @@ +--- +id: v2024-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTask', 'V2024LoadUncorrelatedAccountsTask'] +slug: /tools/sdk/python/v2024/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'V2024LoadUncorrelatedAccountsTask'] +--- + +# LoadUncorrelatedAccountsTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **bool** | The status of the result | [optional] [default to True] +**task** | [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask + +load_uncorrelated_accounts_task = LoadUncorrelatedAccountsTask( +success=True, +task=sailpoint.v2024.models.load_uncorrelated_accounts_task_task.LoadUncorrelatedAccountsTask_task( + id = '90b83a6bb737489494794f84cd3a51e6', + type = 'QUARTZ', + name = 'Cloud Process Uncorrelated Accounts', + description = 'Processes uncorrelated accounts for the specified application.', + launcher = 'John Doe', + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + launched = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completed = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completion_status = 'Success', + parent_name = 'Audit Report', + messages = [], + progress = 'Initializing...', + attributes = sailpoint.v2024.models.load_uncorrelated_accounts_task_task_attributes.LoadUncorrelatedAccountsTask_task_attributes( + qpoc_job_id = '5d303d46-fc51-48cd-9c6d-4e211e3ab63c', + task_start_delay = sailpoint.v2024.models.task_start_delay.taskStartDelay(), ), + returns = [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..6a2af78a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,61 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'V2024LoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/python/v2024/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'V2024LoadUncorrelatedAccountsTaskTask'] +--- + +# LoadUncorrelatedAccountsTaskTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this taskStatus represents | [optional] +**type** | **str** | Type of task this task represents | [optional] +**name** | **str** | The name of uncorrelated accounts process | [optional] +**description** | **str** | The description of the task | [optional] +**launcher** | **str** | The user who initiated the task | [optional] +**created** | **datetime** | The Task creation date | [optional] +**launched** | **datetime** | The task start date | [optional] +**completed** | **datetime** | The task completion date | [optional] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Task completion status. | [optional] +**parent_name** | **str** | Name of the parent task if exists. | [optional] +**messages** | [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**progress** | **str** | Current task state. | [optional] +**attributes** | [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**returns** | **object** | Return values from the task | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_uncorrelated_accounts_task_task import LoadUncorrelatedAccountsTaskTask + +load_uncorrelated_accounts_task_task = LoadUncorrelatedAccountsTaskTask( +id='90b83a6bb737489494794f84cd3a51e6', +type='QUARTZ', +name='Cloud Process Uncorrelated Accounts', +description='Processes uncorrelated accounts for the specified application.', +launcher='John Doe', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success', +parent_name='Audit Report', +messages=[], +progress='Initializing...', +attributes=sailpoint.v2024.models.load_uncorrelated_accounts_task_task_attributes.LoadUncorrelatedAccountsTask_task_attributes( + qpoc_job_id = '5d303d46-fc51-48cd-9c6d-4e211e3ab63c', + task_start_delay = sailpoint.v2024.models.task_start_delay.taskStartDelay(), ), +returns=[{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..ab5b67f86 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,36 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2024LoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/python/v2024/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2024LoadUncorrelatedAccountsTaskTaskAttributes'] +--- + +# LoadUncorrelatedAccountsTaskTaskAttributes + +Extra attributes map(dictionary) for the task. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**qpoc_job_id** | **str** | The id of qpoc job | [optional] +**task_start_delay** | **object** | the task start delay value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_uncorrelated_accounts_task_task_attributes import LoadUncorrelatedAccountsTaskTaskAttributes + +load_uncorrelated_accounts_task_task_attributes = LoadUncorrelatedAccountsTaskTaskAttributes( +qpoc_job_id='5d303d46-fc51-48cd-9c6d-4e211e3ab63c', +task_start_delay=sailpoint.v2024.models.task_start_delay.taskStartDelay() +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..c51b7a4fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2024LoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/python/v2024/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2024LoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message. | [optional] +**error** | **bool** | Flag whether message is an error. | [optional] [default to False] +**warning** | **bool** | Flag whether message is a warning. | [optional] [default to False] +**key** | **str** | Message string identifier. | [optional] +**localized_text** | **str** | Message context with the locale based language. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.load_uncorrelated_accounts_task_task_messages_inner import LoadUncorrelatedAccountsTaskTaskMessagesInner + +load_uncorrelated_accounts_task_task_messages_inner = LoadUncorrelatedAccountsTaskTaskMessagesInner( +type='WARN', +error=False, +warning=True, +key='This correlation failed because the currently running correlation must complete before the next one can start.', +localized_text='This correlation failed because the currently running correlation must complete before the next one can start.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LocaleOrigin.md b/docs/tools/sdk/python/Reference/V2024/Models/LocaleOrigin.md new file mode 100644 index 000000000..df523a38b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LocaleOrigin.md @@ -0,0 +1,23 @@ +--- +id: v2024-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LocaleOrigin', 'V2024LocaleOrigin'] +slug: /tools/sdk/python/v2024/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'V2024LocaleOrigin'] +--- + +# LocaleOrigin + +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. + +## Enum + +* `DEFAULT` (value: `'DEFAULT'`) + +* `REQUEST` (value: `'REQUEST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LocalizedMessage.md b/docs/tools/sdk/python/Reference/V2024/Models/LocalizedMessage.md new file mode 100644 index 000000000..b4bea1ac0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LocalizedMessage.md @@ -0,0 +1,36 @@ +--- +id: v2024-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LocalizedMessage', 'V2024LocalizedMessage'] +slug: /tools/sdk/python/v2024/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'V2024LocalizedMessage'] +--- + +# LocalizedMessage + +Localized error message to indicate a failed invocation or error if any. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | Message locale | [required] +**message** | **str** | Message text | [required] +} + +## Example + +```python +from sailpoint.v2024.models.localized_message import LocalizedMessage + +localized_message = LocalizedMessage( +locale='An error has occurred!', +message='Error has occurred!' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LookupStep.md b/docs/tools/sdk/python/Reference/V2024/Models/LookupStep.md new file mode 100644 index 000000000..5b01f23e0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LookupStep.md @@ -0,0 +1,38 @@ +--- +id: v2024-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LookupStep', 'V2024LookupStep'] +slug: /tools/sdk/python/v2024/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'V2024LookupStep'] +--- + +# LookupStep + +The definition of an Identity according to the Reassignment Configuration service + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassigned_to_id** | **str** | The ID of the Identity who work is reassigned to | [optional] +**reassigned_from_id** | **str** | The ID of the Identity who work is reassigned from | [optional] +**reassignment_type** | [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.lookup_step import LookupStep + +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/MachineAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/MachineAccount.md new file mode 100644 index 000000000..cd01409b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MachineAccount.md @@ -0,0 +1,73 @@ +--- +id: v2024-machine-account +title: MachineAccount +pagination_label: MachineAccount +sidebar_label: MachineAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MachineAccount', 'V2024MachineAccount'] +slug: /tools/sdk/python/v2024/models/machine-account +tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2024MachineAccount'] +--- + +# MachineAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | A description of the machine account | [optional] +**native_identity** | **str** | The unique ID of the machine account generated by the source system | [required] +**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional] +**classification_method** | **Enum** [ 'SOURCE', 'CRITERIA', 'DISCOVERY', 'MANUAL' ] | Classification Method | [required] +**machine_identity** | **object** | The machine identity this account is associated with | [optional] +**owner_identity** | **object** | The identity who owns this account. | [optional] +**access_type** | **str** | The connection type of the source this account is from | [optional] +**subtype** | **str** | The sub-type | [optional] +**environment** | **str** | Environment | [optional] +**attributes** | **map[string]object** | Custom attributes specific to the machine account | [optional] +**connector_attributes** | **map[string]object** | The connector attributes for the account | [required] +**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [optional] [default to False] +**manually_edited** | **bool** | Indicates if the account has been manually edited | [required][default to False] +**locked** | **bool** | Indicates if the account is currently locked | [required] +**enabled** | **bool** | Indicates if the account is enabled | [required][default to False] +**has_entitlements** | **bool** | Indicates if the account has entitlements | [required][default to True] +**source** | **object** | The source this machine account belongs to. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.machine_account import MachineAccount + +machine_account = MachineAccount( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +description='Service account for Active Directory', +native_identity='552775', +uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}', +classification_method='SOURCE', +machine_identity={id=1540e5a4-6c2e-4bf1-b88e-c08cae0696e9, type=MACHINE_IDENTITY, name=SVC_ADService}, +owner_identity={id=2c918084660f45d6016617daa9210584, type=IDENTITY, name=Adam Kennedy}, +access_type='direct', +subtype='', +environment='TEST', +attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support}, +connector_attributes={mail=machine-178@sailpoint.com, givenName=Support, displayName=SailPoint Support}, +manually_correlated=True, +manually_edited=True, +locked=False, +enabled=False, +has_entitlements=False, +source={id=8d3e0094e99445de98eef6c75e25jc04, type=SOURCE, name=Active Directory} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MachineIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/MachineIdentity.md new file mode 100644 index 000000000..2d0f169cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MachineIdentity.md @@ -0,0 +1,47 @@ +--- +id: v2024-machine-identity +title: MachineIdentity +pagination_label: MachineIdentity +sidebar_label: MachineIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MachineIdentity', 'V2024MachineIdentity'] +slug: /tools/sdk/python/v2024/models/machine-identity +tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2024MachineIdentity'] +--- + +# MachineIdentity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**business_application** | **str** | The business application that the identity represents | [required] +**description** | **str** | Description of machine identity | [optional] +**manually_edited** | **bool** | Indicates if the machine identity has been manually edited | [optional] [default to False] +**attributes** | **object** | A map of custom machine identity attributes | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.machine_identity import MachineIdentity + +machine_identity = MachineIdentity( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +business_application='ADService', +description='', +manually_edited=True, +attributes={"Region":"EU"} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MailFromAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/MailFromAttributes.md new file mode 100644 index 000000000..4b96c8c3e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MailFromAttributes.md @@ -0,0 +1,42 @@ +--- +id: v2024-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MailFromAttributes', 'V2024MailFromAttributes'] +slug: /tools/sdk/python/v2024/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'V2024MailFromAttributes'] +--- + +# MailFromAttributes + +MAIL FROM attributes for a domain / identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **str** | The email identity | [optional] +**mail_from_domain** | **str** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**mx_record** | **str** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**txt_record** | **str** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**mail_from_domain_status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED' ] | The current status of the MAIL FROM verification | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes + +mail_from_attributes = MailFromAttributes( +identity='bob.smith@sailpoint.com', +mail_from_domain='foo.sailpoint.com', +mx_record='10 feedback-smtp.us-east-1.amazonses.com', +txt_record='v=spf1 include:amazonses.com ~all', +mail_from_domain_status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MailFromAttributesDto.md b/docs/tools/sdk/python/Reference/V2024/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..5327abb4d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MailFromAttributesDto.md @@ -0,0 +1,36 @@ +--- +id: v2024-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MailFromAttributesDto', 'V2024MailFromAttributesDto'] +slug: /tools/sdk/python/v2024/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'V2024MailFromAttributesDto'] +--- + +# MailFromAttributesDto + +MAIL FROM attributes for a domain / identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **str** | The identity or domain address | [optional] +**mail_from_domain** | **str** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.mail_from_attributes_dto import MailFromAttributesDto + +mail_from_attributes_dto = MailFromAttributesDto( +identity='BobSmith@sailpoint.com', +mail_from_domain='example.sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md new file mode 100644 index 000000000..3874acc1f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md @@ -0,0 +1,74 @@ +--- +id: v2024-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClient', 'V2024ManagedClient'] +slug: /tools/sdk/python/v2024/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'V2024ManagedClient'] +--- + +# ManagedClient + +Managed Client + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ManagedClient ID | [optional] [readonly] +**alert_key** | **str** | ManagedClient alert key | [optional] [readonly] +**api_gateway_base_url** | **str** | | [optional] +**cookbook** | **str** | | [optional] +**cc_id** | **int** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**client_id** | **str** | The client ID used in API management | [required] +**cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] +**description** | **str** | ManagedClient description | [required][default to ''] +**ip_address** | **str** | The public IP address of the ManagedClient | [optional] [readonly] +**last_seen** | **datetime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**name** | **str** | ManagedClient name | [optional] [default to 'VA-$clientId'] +**since_last_seen** | **str** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**status** | **Enum** [ 'NORMAL', 'UNDEFINED', 'NOT_CONFIGURED', 'CONFIGURING', 'WARNING', 'ERROR', 'FAILED' ] | Status of the ManagedClient | [optional] [readonly] +**type** | **str** | Type of the ManagedClient (VA, CCG) | [required] +**cluster_type** | **Enum** [ 'idn', 'iai', 'spConnectCluster', 'sqsCluster', 'das-rc', 'das-pc', 'das-dc' ] | Cluster Type of the ManagedClient | [optional] [readonly] +**va_download_url** | **str** | ManagedClient VA download URL | [optional] [readonly] +**va_version** | **str** | Version that the ManagedClient's VA is running | [optional] [readonly] +**secret** | **str** | Client's apiKey | [optional] +**created_at** | **datetime** | The date/time this ManagedClient was created | [optional] +**updated_at** | **datetime** | The date/time this ManagedClient was last updated | [optional] +**provision_status** | **Enum** [ 'PROVISIONED', 'DRAFT' ] | The provisioning status of the ManagedClient | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.managed_client import ManagedClient + +managed_client = ManagedClient( +id='2c9180878eaf4204018eb019c3570003', +alert_key='CLIENT_STATUS_NOT_CONFIGURED', +api_gateway_base_url='', +cookbook='', +cc_id=2248, +client_id='00be54a2-bb6d-402f-9159-beb2d5319347', +cluster_id='e1ff7bb24c934240bbf55e1aa39e41c5', +description='', +ip_address='123.456.78.90', +last_seen='2020-01-01T00:00Z', +name='VA-$clientId', +since_last_seen='15000', +status='NORMAL', +type='VA', +cluster_type='idn', +va_download_url='aUrl', +va_version='va-megapod-useast1-610-1621372012', +secret='ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381', +created_at='2023-08-04T20:48:01.865Z', +updated_at='2023-08-04T20:48:01.865Z', +provision_status='PROVISIONED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientRequest.md new file mode 100644 index 000000000..edae7ec87 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientRequest', 'V2024ManagedClientRequest'] +slug: /tools/sdk/python/v2024/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'V2024ManagedClientRequest'] +--- + +# ManagedClientRequest + +Managed Client Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] +**description** | **str** | description for the ManagedClient to create | [optional] +**name** | **str** | name for the ManagedClient to create | [optional] +**type** | **str** | Type of the ManagedClient (VA, CCG) to create | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_client_request import ManagedClientRequest + +managed_client_request = ManagedClientRequest( +cluster_id='aClusterId', +description='A short description of the ManagedClient', +name='aName', +type='VA' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientStatus.md new file mode 100644 index 000000000..19e83f2db --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientStatus.md @@ -0,0 +1,40 @@ +--- +id: v2024-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatus', 'V2024ManagedClientStatus'] +slug: /tools/sdk/python/v2024/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'V2024ManagedClientStatus'] +--- + +# ManagedClientStatus + +Managed Client Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | **object** | ManagedClientStatus body information | [required] +**status** | [**ManagedClientStatusCode**](managed-client-status-code) | | [required] +**type** | [**ManagedClientType**](managed-client-type) | | [required] +**timestamp** | **datetime** | timestamp on the Client Status update | [required] +} + +## Example + +```python +from sailpoint.v2024.models.managed_client_status import ManagedClientStatus + +managed_client_status = ManagedClientStatus( +body={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='NORMAL', +type='CCG', +timestamp='2020-01-01T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientStatusCode.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..9228e8554 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientStatusCode.md @@ -0,0 +1,33 @@ +--- +id: v2024-managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatusCode', 'V2024ManagedClientStatusCode'] +slug: /tools/sdk/python/v2024/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'V2024ManagedClientStatusCode'] +--- + +# ManagedClientStatusCode + +Status of a Managed Client + +## Enum + +* `NORMAL` (value: `'NORMAL'`) + +* `UNDEFINED` (value: `'UNDEFINED'`) + +* `NOT_CONFIGURED` (value: `'NOT_CONFIGURED'`) + +* `CONFIGURING` (value: `'CONFIGURING'`) + +* `WARNING` (value: `'WARNING'`) + +* `ERROR` (value: `'ERROR'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientType.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientType.md new file mode 100644 index 000000000..92bffe9d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClientType.md @@ -0,0 +1,27 @@ +--- +id: v2024-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientType', 'V2024ManagedClientType'] +slug: /tools/sdk/python/v2024/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'V2024ManagedClientType'] +--- + +# ManagedClientType + +Managed Client type + +## Enum + +* `CCG` (value: `'CCG'`) + +* `VA` (value: `'VA'`) + +* `INTERNAL` (value: `'INTERNAL'`) + +* `IIQ_HARVESTER` (value: `'IIQ_HARVESTER'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md new file mode 100644 index 000000000..afbc8663e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md @@ -0,0 +1,96 @@ +--- +id: v2024-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedCluster', 'V2024ManagedCluster'] +slug: /tools/sdk/python/v2024/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'V2024ManagedCluster'] +--- + +# ManagedCluster + +Managed Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ManagedCluster ID | [required] +**name** | **str** | ManagedCluster name | [optional] +**pod** | **str** | ManagedCluster pod | [optional] +**org** | **str** | ManagedCluster org | [optional] +**type** | [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**configuration** | **map[string]str** | ManagedProcess configuration map | [optional] +**key_pair** | [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**attributes** | [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**description** | **str** | ManagedCluster description | [optional] [default to 'q'] +**redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**client_type** | [**ManagedClientType**](managed-client-type) | | [required] +**ccg_version** | **str** | CCG version used by the ManagedCluster | [required] +**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False] +**log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional] +**operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False] +**status** | **str** | Cluster status | [optional] +**public_key_certificate** | **str** | Public key certificate | [optional] +**public_key_thumbprint** | **str** | Public key thumbprint | [optional] +**public_key** | **str** | Public key | [optional] +**alert_key** | **str** | Key describing any immediate cluster alerts | [optional] +**client_ids** | **[]str** | List of clients in a cluster | [optional] +**service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0] +**cc_id** | **str** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to '0'] +**created_at** | **datetime** | The date/time this cluster was created | [optional] +**updated_at** | **datetime** | The date/time this cluster was last updated | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster import ManagedCluster + +managed_cluster = ManagedCluster( +id='e1ff7bb24c934240bbf55e1aa39e41c5', +name='Managed Cluster Name', +pod='megapod-useast1', +org='denali', +type='idn', +configuration={clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5}, +key_pair=sailpoint.v2024.models.managed_cluster_key_pair.ManagedClusterKeyPair( + public_key = '-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----', + public_key_thumbprint = '6CMlaJIV44-xJxcB3CJBjDUUn54', + public_key_certificate = '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', ), +attributes=sailpoint.v2024.models.managed_cluster_attributes.ManagedClusterAttributes( + queue = sailpoint.v2024.models.managed_cluster_queue.ManagedClusterQueue( + name = 'megapod-useast1-denali-lwt-cluster-1533', + region = 'us-east-1', ), + keystore = '/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW', ), +description='q', +redis=sailpoint.v2024.models.managed_cluster_redis.ManagedClusterRedis( + redis_host = 'megapod-useast1-shared-redis.cloud.sailpoint.com', + redis_port = 6379, ), +client_type='CCG', +ccg_version='v01', +pinned_config=False, +log_configuration=sailpoint.v2024.models.client_log_configuration.ClientLogConfiguration( + client_id = '3a38a51992e8445ab51a549c0a70ee66', + duration_minutes = 120, + expiration = '2024-11-06T01:31:08.013164Z', + root_level = 'INFO', + log_levels = INFO, ), +operational=False, +status='NORMAL', +public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----', +public_key_thumbprint='obc6pLiulGbtZ', +public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----', +alert_key='LIMITED_RESOURCES', +client_ids=[1244, 1245], +service_count=6, +cc_id='0', +created_at='2023-08-04T20:48:01.865Z', +updated_at='2023-08-04T20:48:01.865Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..5ab7adddf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterAttributes.md @@ -0,0 +1,38 @@ +--- +id: v2024-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterAttributes', 'V2024ManagedClusterAttributes'] +slug: /tools/sdk/python/v2024/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'V2024ManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**queue** | [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**keystore** | **str** | ManagedCluster keystore for spConnectCluster type | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_attributes import ManagedClusterAttributes + +managed_cluster_attributes = ManagedClusterAttributes( +queue=sailpoint.v2024.models.managed_cluster_queue.ManagedClusterQueue( + name = 'megapod-useast1-denali-lwt-cluster-1533', + region = 'us-east-1', ), +keystore='/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..eccf9bc0f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterKeyPair.md @@ -0,0 +1,38 @@ +--- +id: v2024-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterKeyPair', 'V2024ManagedClusterKeyPair'] +slug: /tools/sdk/python/v2024/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'V2024ManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +Managed Cluster key pair for Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**public_key** | **str** | ManagedCluster publicKey | [optional] +**public_key_thumbprint** | **str** | ManagedCluster publicKeyThumbprint | [optional] +**public_key_certificate** | **str** | ManagedCluster publicKeyCertificate | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_key_pair import ManagedClusterKeyPair + +managed_cluster_key_pair = ManagedClusterKeyPair( +public_key='-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----', +public_key_thumbprint='6CMlaJIV44-xJxcB3CJBjDUUn54', +public_key_certificate='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterQueue.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..da1d0bd23 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterQueue.md @@ -0,0 +1,36 @@ +--- +id: v2024-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterQueue', 'V2024ManagedClusterQueue'] +slug: /tools/sdk/python/v2024/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'V2024ManagedClusterQueue'] +--- + +# ManagedClusterQueue + +Managed Cluster key pair for Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | ManagedCluster queue name | [optional] +**region** | **str** | ManagedCluster queue aws region | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_queue import ManagedClusterQueue + +managed_cluster_queue = ManagedClusterQueue( +name='megapod-useast1-denali-lwt-cluster-1533', +region='us-east-1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterRedis.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..b29d319e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterRedis.md @@ -0,0 +1,36 @@ +--- +id: v2024-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterRedis', 'V2024ManagedClusterRedis'] +slug: /tools/sdk/python/v2024/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'V2024ManagedClusterRedis'] +--- + +# ManagedClusterRedis + +Managed Cluster Redis Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**redis_host** | **str** | ManagedCluster redisHost | [optional] +**redis_port** | **int** | ManagedCluster redisPort | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_redis import ManagedClusterRedis + +managed_cluster_redis = ManagedClusterRedis( +redis_host='megapod-useast1-shared-redis.cloud.sailpoint.com', +redis_port=6379 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..3f9a85fe4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterRequest', 'V2024ManagedClusterRequest'] +slug: /tools/sdk/python/v2024/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'V2024ManagedClusterRequest'] +--- + +# ManagedClusterRequest + +Request to create Managed Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | ManagedCluster name | [required] +**type** | [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**configuration** | **map[string]str** | ManagedProcess configuration map | [optional] +**description** | **str** | ManagedCluster description | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_request import ManagedClusterRequest + +managed_cluster_request = ManagedClusterRequest( +name='Managed Cluster Name', +type='idn', +configuration={clusterExternalId=externalId, ccgVersion=77.0.0}, +description='A short description of the managed cluster.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterTypes.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..a581d19f0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterTypes.md @@ -0,0 +1,23 @@ +--- +id: v2024-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +slug: /tools/sdk/python/v2024/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +--- + +# ManagedClusterTypes + +The Type of Cluster + +## Enum + +* `IDN` (value: `'idn'`) + +* `IAI` (value: `'iai'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..a289c07fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagerCorrelationMapping.md @@ -0,0 +1,35 @@ +--- +id: v2024-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagerCorrelationMapping', 'V2024ManagerCorrelationMapping'] +slug: /tools/sdk/python/v2024/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'V2024ManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_attribute_name** | **str** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**identity_attribute_name** | **str** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.manager_correlation_mapping import ManagerCorrelationMapping + +manager_correlation_mapping = ManagerCorrelationMapping( +account_attribute_name='manager', +identity_attribute_name='manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManualDiscoverApplications.md b/docs/tools/sdk/python/Reference/V2024/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..27425b7c7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManualDiscoverApplications.md @@ -0,0 +1,35 @@ +--- +id: v2024-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualDiscoverApplications', 'V2024ManualDiscoverApplications'] +slug: /tools/sdk/python/v2024/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'V2024ManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.manual_discover_applications import ManualDiscoverApplications + +manual_discover_applications = ManualDiscoverApplications( +file='application_name,description +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App."' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/python/Reference/V2024/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..22dae90d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,35 @@ +--- +id: v2024-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualDiscoverApplicationsTemplate', 'V2024ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/python/v2024/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'V2024ManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_name** | **str** | Name of the application. | [optional] +**description** | **str** | Description of the application. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate + +manual_discover_applications_template = ManualDiscoverApplicationsTemplate( +application_name='Example Application', +description='Example Description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..c4309450f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetails.md @@ -0,0 +1,57 @@ +--- +id: v2024-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetails', 'V2024ManualWorkItemDetails'] +slug: /tools/sdk/python/v2024/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'V2024ManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False] +**original_owner** | [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**current_owner** | [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**modified** | **datetime** | Time at which item was modified. | [optional] +**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.manual_work_item_details import ManualWorkItemDetails + +manual_work_item_details = ManualWorkItemDetails( +forwarded=True, +original_owner=sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +current_owner=sailpoint.v2024.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +modified='2019-08-23T18:52:57.398Z', +status='PENDING', +forward_history=[ + sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..3f8056582 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'V2024ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/python/v2024/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'V2024ManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +Identity of current work item owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of current work item owner's identity. | [optional] +**id** | **str** | ID of current work item owner's identity. | [optional] +**name** | **str** | Display name of current work item owner. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.manual_work_item_details_current_owner import ManualWorkItemDetailsCurrentOwner + +manual_work_item_details_current_owner = ManualWorkItemDetailsCurrentOwner( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..deecea044 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'V2024ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/python/v2024/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'V2024ManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +Identity of original work item owner, if the work item has been forwarded. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original work item owner's identity. | [optional] +**id** | **str** | ID of original work item owner's identity. | [optional] +**name** | **str** | Display name of original work item owner. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.manual_work_item_details_original_owner import ManualWorkItemDetailsOriginalOwner + +manual_work_item_details_original_owner = ManualWorkItemDetailsOriginalOwner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemState.md b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemState.md new file mode 100644 index 000000000..507928dba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemState.md @@ -0,0 +1,31 @@ +--- +id: v2024-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemState', 'V2024ManualWorkItemState'] +slug: /tools/sdk/python/v2024/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'V2024ManualWorkItemState'] +--- + +# ManualWorkItemState + +Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. + +## Enum + +* `PENDING` (value: `'PENDING'`) + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `EXPIRED` (value: `'EXPIRED'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +* `ARCHIVED` (value: `'ARCHIVED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MatchTerm.md b/docs/tools/sdk/python/Reference/V2024/Models/MatchTerm.md new file mode 100644 index 000000000..2bd3be1f0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MatchTerm.md @@ -0,0 +1,43 @@ +--- +id: v2024-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MatchTerm', 'V2024MatchTerm'] +slug: /tools/sdk/python/v2024/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'V2024MatchTerm'] +--- + +# MatchTerm + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The attribute name | [optional] +**value** | **str** | The attribute value | [optional] +**op** | **str** | The operator between name and value | [optional] +**container** | **bool** | If it is a container or a real match term | [optional] [default to False] +**var_and** | **bool** | If it is AND logical operator for the children match terms | [optional] [default to False] +**children** | **[]Dict[str, object]** | The children under this match term | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.match_term import MatchTerm + +match_term = MatchTerm( +name='mail', +value='1234 Albany Dr', +op='eq', +container=True, +var_and=False, +children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Medium.md b/docs/tools/sdk/python/Reference/V2024/Models/Medium.md new file mode 100644 index 000000000..a0841c5ea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Medium.md @@ -0,0 +1,28 @@ +--- +id: v2024-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Medium', 'V2024Medium'] +slug: /tools/sdk/python/v2024/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'V2024Medium'] +--- + +# Medium + + +## Enum + +* `EMAIL` (value: `'EMAIL'`) + +* `SMS` (value: `'SMS'`) + +* `PHONE` (value: `'PHONE'`) + +* `SLACK` (value: `'SLACK'`) + +* `TEAMS` (value: `'TEAMS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MembershipType.md b/docs/tools/sdk/python/Reference/V2024/Models/MembershipType.md new file mode 100644 index 000000000..9ad01bc83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MembershipType.md @@ -0,0 +1,25 @@ +--- +id: v2024-membership-type +title: MembershipType +pagination_label: MembershipType +sidebar_label: MembershipType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MembershipType', 'V2024MembershipType'] +slug: /tools/sdk/python/v2024/models/membership-type +tags: ['SDK', 'Software Development Kit', 'MembershipType', 'V2024MembershipType'] +--- + +# MembershipType + +An enumeration of the types of membership choices + +## Enum + +* `ALL` (value: `'ALL'`) + +* `FILTER` (value: `'FILTER'`) + +* `SELECTION` (value: `'SELECTION'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MetricAggregation.md b/docs/tools/sdk/python/Reference/V2024/Models/MetricAggregation.md new file mode 100644 index 000000000..8dae65b66 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MetricAggregation.md @@ -0,0 +1,38 @@ +--- +id: v2024-metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MetricAggregation', 'V2024MetricAggregation'] +slug: /tools/sdk/python/v2024/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'V2024MetricAggregation'] +--- + +# MetricAggregation + +The calculation done on the results of the query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | 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. | [required] +**type** | [**MetricType**](metric-type) | | [optional] [default to MetricType.UNIQUE_COUNT] +**var_field** | **str** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.metric_aggregation import MetricAggregation + +metric_aggregation = MetricAggregation( +name='Access Name Count', +type='UNIQUE_COUNT', +var_field='@access.name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MetricResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/MetricResponse.md new file mode 100644 index 000000000..a2febd052 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MetricResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MetricResponse', 'V2024MetricResponse'] +slug: /tools/sdk/python/v2024/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'V2024MetricResponse'] +--- + +# MetricResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of metric | [optional] +**value** | **float** | the value associated to the metric | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.metric_response import MetricResponse + +metric_response = MetricResponse( +name='', +value=1.337 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MetricType.md b/docs/tools/sdk/python/Reference/V2024/Models/MetricType.md new file mode 100644 index 000000000..0f642d69a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MetricType.md @@ -0,0 +1,33 @@ +--- +id: v2024-metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MetricType', 'V2024MetricType'] +slug: /tools/sdk/python/v2024/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'V2024MetricType'] +--- + +# MetricType + +Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. + +## Enum + +* `COUNT` (value: `'COUNT'`) + +* `UNIQUE_COUNT` (value: `'UNIQUE_COUNT'`) + +* `AVG` (value: `'AVG'`) + +* `SUM` (value: `'SUM'`) + +* `MEDIAN` (value: `'MEDIAN'`) + +* `MIN` (value: `'MIN'`) + +* `MAX` (value: `'MAX'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MfaConfigTestResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..e4c35715f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MfaConfigTestResponse.md @@ -0,0 +1,36 @@ +--- +id: v2024-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaConfigTestResponse', 'V2024MfaConfigTestResponse'] +slug: /tools/sdk/python/v2024/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'V2024MfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +Response model for configuration test of a given MFA method + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'FAILED' ] | The configuration test result. | [optional] [readonly] +**error** | **str** | The error message to indicate the failure of configuration test. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse + +mfa_config_test_response = MfaConfigTestResponse( +state='SUCCESS', +error='MFA Method is disabled.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MfaDuoConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/MfaDuoConfig.md new file mode 100644 index 000000000..d466042b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MfaDuoConfig.md @@ -0,0 +1,43 @@ +--- +id: v2024-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaDuoConfig', 'V2024MfaDuoConfig'] +slug: /tools/sdk/python/v2024/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'V2024MfaDuoConfig'] +--- + +# MfaDuoConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfa_method** | **str** | Mfa method name | [optional] +**enabled** | **bool** | If MFA method is enabled. | [optional] [default to False] +**host** | **str** | The server host name or IP address of the MFA provider. | [optional] +**access_key** | **str** | The secret key for authenticating requests to the MFA provider. | [optional] +**identity_attribute** | **str** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**config_properties** | **map[string]object** | A map with additional config properties for the given MFA method - duo-web. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig + +mfa_duo_config = MfaDuoConfig( +mfa_method='duo-web', +enabled=True, +host='example.com', +access_key='qw123Y3QlA5UqocYpdU3rEkzrK2D497y', +identity_attribute='email', +config_properties={skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MfaOktaConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/MfaOktaConfig.md new file mode 100644 index 000000000..b9f09872c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MfaOktaConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaOktaConfig', 'V2024MfaOktaConfig'] +slug: /tools/sdk/python/v2024/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'V2024MfaOktaConfig'] +--- + +# MfaOktaConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfa_method** | **str** | Mfa method name | [optional] +**enabled** | **bool** | If MFA method is enabled. | [optional] [default to False] +**host** | **str** | The server host name or IP address of the MFA provider. | [optional] +**access_key** | **str** | The secret key for authenticating requests to the MFA provider. | [optional] +**identity_attribute** | **str** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig + +mfa_okta_config = MfaOktaConfig( +mfa_method='okta-verify', +enabled=True, +host='example.com', +access_key='qw123Y3QlA5UqocYpdU3rEkzrK2D497y', +identity_attribute='email' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ModelSchema.md b/docs/tools/sdk/python/Reference/V2024/Models/ModelSchema.md new file mode 100644 index 000000000..c275a3740 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ModelSchema.md @@ -0,0 +1,55 @@ +--- +id: v2024-model-schema +title: ModelSchema +pagination_label: ModelSchema +sidebar_label: ModelSchema +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ModelSchema', 'V2024ModelSchema'] +slug: /tools/sdk/python/v2024/models/model-schema +tags: ['SDK', 'Software Development Kit', 'ModelSchema', 'V2024ModelSchema'] +--- + +# ModelSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Schema. | [optional] +**name** | **str** | The name of the Schema. | [optional] +**native_object_type** | **str** | The name of the object type on the native system that the schema represents. | [optional] +**identity_attribute** | **str** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**display_attribute** | **str** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**hierarchy_attribute** | **str** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**configuration** | **object** | Holds any extra configuration data that the schema may require. | [optional] +**attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**created** | **datetime** | The date the Schema was created. | [optional] +**modified** | **datetime** | The date the Schema was last modified. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.model_schema import ModelSchema + +model_schema = ModelSchema( +id='2c9180835d191a86015d28455b4a2329', +name='account', +native_object_type='User', +identity_attribute='sAMAccountName', +display_attribute='distinguishedName', +hierarchy_attribute='memberOf', +include_permissions=False, +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +configuration={groupMemberAttribute=member}, +attributes=[{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}], +created='2019-12-24T22:32:58.104Z', +modified='2019-12-31T20:22:28.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/MultiPolicyRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..09c2dabf6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/MultiPolicyRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiPolicyRequest', 'V2024MultiPolicyRequest'] +slug: /tools/sdk/python/v2024/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'V2024MultiPolicyRequest'] +--- + +# MultiPolicyRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filtered_policy_list** | **[]str** | Multi-policy report will be run for this list of ids | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest + +multi_policy_request = MultiPolicyRequest( +filtered_policy_list=[ + '[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..7b619a9e5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,44 @@ +--- +id: v2024-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NativeChangeDetectionConfig', 'V2024NativeChangeDetectionConfig'] +slug: /tools/sdk/python/v2024/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'V2024NativeChangeDetectionConfig'] +--- + +# NativeChangeDetectionConfig + +Source configuration information for Native Change Detection that is read and used by account aggregation process. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to False] +**operations** | **[]str** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**all_entitlements** | **bool** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to False] +**all_non_entitlement_attributes** | **bool** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to False] +**selected_entitlements** | **[]str** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**selected_non_entitlement_attributes** | **[]str** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.native_change_detection_config import NativeChangeDetectionConfig + +native_change_detection_config = NativeChangeDetectionConfig( +enabled=True, +operations=[ACCOUNT_UPDATED, ACCOUNT_DELETED], +all_entitlements=False, +all_non_entitlement_attributes=False, +selected_entitlements=[memberOf, memberOfSharedMailbox], +selected_non_entitlement_attributes=[lastName, phoneNumber, objectType, servicePrincipalName] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NestedAggregation.md b/docs/tools/sdk/python/Reference/V2024/Models/NestedAggregation.md new file mode 100644 index 000000000..e36d87a98 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NestedAggregation.md @@ -0,0 +1,36 @@ +--- +id: v2024-nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NestedAggregation', 'V2024NestedAggregation'] +slug: /tools/sdk/python/v2024/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'V2024NestedAggregation'] +--- + +# NestedAggregation + +The nested aggregation object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the nested aggregate to be included in the result. | [required] +**type** | **str** | The type of the nested object. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.nested_aggregation import NestedAggregation + +nested_aggregation = NestedAggregation( +name='id', +type='access' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NetworkConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/NetworkConfiguration.md new file mode 100644 index 000000000..1411c39a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NetworkConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NetworkConfiguration', 'V2024NetworkConfiguration'] +slug: /tools/sdk/python/v2024/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'V2024NetworkConfiguration'] +--- + +# NetworkConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**range** | **[]str** | The collection of ip ranges. | [optional] +**geolocation** | **[]str** | The collection of country codes. | [optional] +**whitelisted** | **bool** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.network_configuration import NetworkConfiguration + +network_configuration = NetworkConfiguration( +range=[1.3.7.2, 255.255.255.252/30], +geolocation=[CA, FR, HT], +whitelisted=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..52f8e8267 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,33 @@ +--- +id: v2024-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalDecision', 'V2024NonEmployeeApprovalDecision'] +slug: /tools/sdk/python/v2024/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'V2024NonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment on the approval item. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_approval_decision import NonEmployeeApprovalDecision + +non_employee_approval_decision = NonEmployeeApprovalDecision( +comment='Approved by manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..39320a1bd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,55 @@ +--- +id: v2024-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItem', 'V2024NonEmployeeApprovalItem'] +slug: /tools/sdk/python/v2024/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'V2024NonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_request** | [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_approval_item import NonEmployeeApprovalItem + +non_employee_approval_item = NonEmployeeApprovalItem( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='I approve', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_request=sailpoint.v2024.models.non_employee_request_lite.NonEmployeeRequestLite( + id = 'ac110005-7156-1150-8171-5b292e3e0084', + requester = sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..759fe5d96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,49 @@ +--- +id: v2024-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItemBase', 'V2024NonEmployeeApprovalItemBase'] +slug: /tools/sdk/python/v2024/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'V2024NonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_approval_item_base import NonEmployeeApprovalItemBase + +non_employee_approval_item_base = NonEmployeeApprovalItemBase( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='I approve', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..002015a59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItemDetail', 'V2024NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/python/v2024/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'V2024NonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_request** | [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail + +non_employee_approval_item_detail = NonEmployeeApprovalItemDetail( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='I approve', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_request= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..8e9fc491e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,37 @@ +--- +id: v2024-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalSummary', 'V2024NonEmployeeApprovalSummary'] +slug: /tools/sdk/python/v2024/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'V2024NonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **int** | The number of approved non-employee approval requests. | [optional] +**pending** | **int** | The number of pending non-employee approval requests. | [optional] +**rejected** | **int** | The number of rejected non-employee approval requests. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_approval_summary import NonEmployeeApprovalSummary + +non_employee_approval_summary = NonEmployeeApprovalSummary( +approved=2, +pending=2, +rejected=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..41246a53f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,41 @@ +--- +id: v2024-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeBulkUploadJob', 'V2024NonEmployeeBulkUploadJob'] +slug: /tools/sdk/python/v2024/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'V2024NonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The bulk upload job's ID. (UUID) | [optional] +**source_id** | **str** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**created** | **datetime** | The date-time the job was submitted. | [optional] +**modified** | **datetime** | The date-time that the job was last updated. | [optional] +**status** | **Enum** [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'ERROR' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob + +non_employee_bulk_upload_job = NonEmployeeBulkUploadJob( +id='2c91808568c529c60168cca6f90cffff', +source_id='2c91808568c529c60168cca6f90c1313', +created='2019-08-23T18:52:59.162Z', +modified='2019-08-23T18:52:59.162Z', +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..b1ee24289 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,33 @@ +--- +id: v2024-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeBulkUploadStatus', 'V2024NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/python/v2024/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'V2024NonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'ERROR' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus + +non_employee_bulk_upload_status = NonEmployeeBulkUploadStatus( +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..439b02206 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,23 @@ +--- +id: v2024-non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdentityDtoType', 'V2024NonEmployeeIdentityDtoType'] +slug: /tools/sdk/python/v2024/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'V2024NonEmployeeIdentityDtoType'] +--- + +# NonEmployeeIdentityDtoType + +Identifies if the identity is a normal identity or a governance group + +## Enum + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..10af541d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,35 @@ +--- +id: v2024-non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'V2024NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/python/v2024/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'V2024NonEmployeeIdentityReferenceWithId'] +--- + +# NonEmployeeIdentityReferenceWithId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_identity_reference_with_id import NonEmployeeIdentityReferenceWithId + +non_employee_identity_reference_with_id = NonEmployeeIdentityReferenceWithId( +type='IDENTITY', +id='5168015d32f890ca15812c9180835d2e' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..b992024bf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdnUserRequest', 'V2024NonEmployeeIdnUserRequest'] +slug: /tools/sdk/python/v2024/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'V2024NonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity id. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_idn_user_request import NonEmployeeIdnUserRequest + +non_employee_idn_user_request = NonEmployeeIdnUserRequest( +id='2c91808570313110017040b06f344ec9' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRecord.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..058fbc083 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRecord.md @@ -0,0 +1,57 @@ +--- +id: v2024-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRecord', 'V2024NonEmployeeRecord'] +slug: /tools/sdk/python/v2024/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'V2024NonEmployeeRecord'] +--- + +# NonEmployeeRecord + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee record id. | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**source_id** | **str** | Non-Employee's source id. | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [optional] +**end_date** | **datetime** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord + +non_employee_record = NonEmployeeRecord( +id='ef38f94347e94562b5bb8424a56397d8', +account_name='Abby.Smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +source_id='2c91808568c529c60168cca6f90c1313', +data={description=Auditing}, +start_date='2019-08-23T18:52:59.162Z', +end_date='2020-08-23T18:52:59.162Z', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..cddf6d778 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,33 @@ +--- +id: v2024-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRejectApprovalDecision', 'V2024NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/python/v2024/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'V2024NonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment on the approval item. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision + +non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision( +comment='approved' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..d852348ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequest.md @@ -0,0 +1,87 @@ +--- +id: v2024-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequest', 'V2024NonEmployeeRequest'] +slug: /tools/sdk/python/v2024/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'V2024NonEmployeeRequest'] +--- + +# NonEmployeeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**non_employee_source** | [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**approval_items** | [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**comment** | **str** | Comment of requester | [optional] +**completion_date** | **datetime** | When the request was completely approved. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [optional] +**end_date** | **datetime** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest + +non_employee_request = NonEmployeeRequest( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +non_employee_source=sailpoint.v2024.models.non_employee_source_lite.NonEmployeeSourceLite( + id = 'a0303682-5e4a-44f7-bdc2-6ce6112549c1', + source_id = '2c91808568c529c60168cca6f90c1313', + name = 'Retail', + description = 'Source description', ), +data={description=Auditing}, +approval_items=[ + sailpoint.v2024.models.non_employee_approval_item_base.NonEmployeeApprovalItemBase( + id = '2c1e388b-1e55-4b0a-ab5c-897f1204159c', + approver = sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), + account_name = 'test.account', + approval_status = 'APPROVED', + approval_order = 1, + comment = 'I approve', + modified = '2019-08-23T18:52:59.162Z', + created = '2019-08-23T18:40:35.772Z', ) + ], +approval_status='APPROVED', +comment='approved', +completion_date='2020-03-24T11:11:41.139-05:00', +start_date='2020-03-24T00:00-05:00', +end_date='2021-03-25T00:00-05:00', +modified='2020-03-24T11:11:41.139-05:00', +created='2020-03-24T11:11:41.139-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..94f63eda7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestBody.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestBody', 'V2024NonEmployeeRequestBody'] +slug: /tools/sdk/python/v2024/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'V2024NonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_name** | **str** | Requested identity account name. | [required] +**first_name** | **str** | Non-Employee's first name. | [required] +**last_name** | **str** | Non-Employee's last name. | [required] +**email** | **str** | Non-Employee's email. | [required] +**phone** | **str** | Non-Employee's phone. | [required] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [required] +**source_id** | **str** | Non-Employee's source id. | [required] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [required] +**end_date** | **datetime** | Non-Employee employment end date. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_request_body import NonEmployeeRequestBody + +non_employee_request_body = NonEmployeeRequestBody( +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +source_id='2c91808568c529c60168cca6f90c1313', +data={description=Auditing}, +start_date='2020-03-24T00:00-05:00', +end_date='2021-03-25T00:00-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..579a341f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestLite.md @@ -0,0 +1,37 @@ +--- +id: v2024-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestLite', 'V2024NonEmployeeRequestLite'] +slug: /tools/sdk/python/v2024/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'V2024NonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee request id. | [optional] +**requester** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_request_lite import NonEmployeeRequestLite + +non_employee_request_lite = NonEmployeeRequestLite( +id='ac110005-7156-1150-8171-5b292e3e0084', +requester=sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..be172f744 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,39 @@ +--- +id: v2024-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestSummary', 'V2024NonEmployeeRequestSummary'] +slug: /tools/sdk/python/v2024/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'V2024NonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **int** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**rejected** | **int** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**pending** | **int** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**non_employee_count** | **int** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_request_summary import NonEmployeeRequestSummary + +non_employee_request_summary = NonEmployeeRequestSummary( +approved=2, +rejected=2, +pending=2, +non_employee_count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..a37f38fea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,67 @@ +--- +id: v2024-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'V2024NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/python/v2024/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'V2024NonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee request id. | [optional] +**requester** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**non_employee_source** | [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**comment** | **str** | Comment of requester | [optional] +**completion_date** | **datetime** | When the request was completely approved. | [optional] +**start_date** | **date** | Non-Employee employment start date. | [optional] +**end_date** | **date** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_request_without_approval_item import NonEmployeeRequestWithoutApprovalItem + +non_employee_request_without_approval_item = NonEmployeeRequestWithoutApprovalItem( +id='ac110005-7156-1150-8171-5b292e3e0084', +requester=sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +non_employee_source=, +data={description=Auditing}, +approval_status='APPROVED', +comment='approved', +completion_date='2020-03-24T11:11:41.139-05:00', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', +modified='2020-03-24T11:11:41.139-05:00', +created='2020-03-24T11:11:41.139-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..98e963fd5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttribute', 'V2024NonEmployeeSchemaAttribute'] +slug: /tools/sdk/python/v2024/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'V2024NonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Schema Attribute Id | [optional] +**system** | **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to False] +**modified** | **datetime** | When the schema attribute was last modified. | [optional] +**created** | **datetime** | When the schema attribute was created. | [optional] +**type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] +**label** | **str** | Label displayed on the UI for this schema attribute. | [required] +**technical_name** | **str** | The technical name of the attribute. Must be unique per source. | [required] +**help_text** | **str** | help text displayed by UI. | [optional] +**placeholder** | **str** | Hint text that fills UI box. | [optional] +**required** | **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + +non_employee_schema_attribute = NonEmployeeSchemaAttribute( +id='ac110005-7156-1150-8171-5b292e3e0084', +system=True, +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +type='TEXT', +label='Account Name', +technical_name='account.name', +help_text='The unique identifier for the account', +placeholder='Enter a unique user name for this account.', +required=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..fe9f2b9fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,43 @@ +--- +id: v2024-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttributeBody', 'V2024NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/python/v2024/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'V2024NonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] +**label** | **str** | Label displayed on the UI for this schema attribute. | [required] +**technical_name** | **str** | The technical name of the attribute. Must be unique per source. | [required] +**help_text** | **str** | help text displayed by UI. | [optional] +**placeholder** | **str** | Hint text that fills UI box. | [optional] +**required** | **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody + +non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody( +type='TEXT', +label='Account Name', +technical_name='account.name', +help_text='The unique identifier for the account', +placeholder='Enter a unique user name for this account.', +required=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..0ff93f324 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,25 @@ +--- +id: v2024-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttributeType', 'V2024NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/python/v2024/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'V2024NonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +Enum representing the type of data a schema attribute accepts. + +## Enum + +* `TEXT` (value: `'TEXT'`) + +* `DATE` (value: `'DATE'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSource.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSource.md new file mode 100644 index 000000000..2e6e0d73a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSource.md @@ -0,0 +1,55 @@ +--- +id: v2024-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSource', 'V2024NonEmployeeSource'] +slug: /tools/sdk/python/v2024/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'V2024NonEmployeeSource'] +--- + +# NonEmployeeSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_source import NonEmployeeSource + +non_employee_source = NonEmployeeSource( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..683591794 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceLite.md @@ -0,0 +1,39 @@ +--- +id: v2024-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceLite', 'V2024NonEmployeeSourceLite'] +slug: /tools/sdk/python/v2024/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'V2024NonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_source_lite import NonEmployeeSourceLite + +non_employee_source_lite = NonEmployeeSourceLite( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..07896d1b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,53 @@ +--- +id: v2024-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2024NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/python/v2024/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2024NonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**schema_attributes** | [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_source_lite_with_schema_attributes import NonEmployeeSourceLiteWithSchemaAttributes + +non_employee_source_lite_with_schema_attributes = NonEmployeeSourceLiteWithSchemaAttributes( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +schema_attributes=[ + sailpoint.v2024.models.non_employee_schema_attribute.NonEmployeeSchemaAttribute( + id = 'ac110005-7156-1150-8171-5b292e3e0084', + system = True, + modified = '2019-08-23T18:52:59.162Z', + created = '2019-08-23T18:40:35.772Z', + type = 'TEXT', + label = 'Account Name', + technical_name = 'account.name', + help_text = 'The unique identifier for the account', + placeholder = 'Enter a unique user name for this account.', + required = True, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..394691f0c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,50 @@ +--- +id: v2024-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceRequestBody', 'V2024NonEmployeeSourceRequestBody'] +slug: /tools/sdk/python/v2024/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'V2024NonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of non-employee source. | [required] +**description** | **str** | Description of non-employee source. | [required] +**owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] +**management_workgroup** | **str** | The ID for the management workgroup that contains source sub-admins | [optional] +**approvers** | [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**account_managers** | [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_source_request_body import NonEmployeeSourceRequestBody + +non_employee_source_request_body = NonEmployeeSourceRequestBody( +name='Retail', +description='Source description', +owner=sailpoint.v2024.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ), +management_workgroup='123299', +approvers=[ + sailpoint.v2024.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ) + ], +account_managers=[ + sailpoint.v2024.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..61182efa0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,57 @@ +--- +id: v2024-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'V2024NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/python/v2024/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'V2024NonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**cloud_external_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId + +non_employee_source_with_cloud_external_id = NonEmployeeSourceWithCloudExternalId( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +cloud_external_id='99999' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..02ce046b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,57 @@ +--- +id: v2024-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceWithNECount', 'V2024NonEmployeeSourceWithNECount'] +slug: /tools/sdk/python/v2024/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'V2024NonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_count** | **int** | 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'. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount + +non_employee_source_with_ne_count = NonEmployeeSourceWithNECount( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.v2024.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_count=120 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/NotificationTemplateContext.md b/docs/tools/sdk/python/Reference/V2024/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..938ce9735 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/NotificationTemplateContext.md @@ -0,0 +1,37 @@ +--- +id: v2024-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NotificationTemplateContext', 'V2024NotificationTemplateContext'] +slug: /tools/sdk/python/v2024/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'V2024NotificationTemplateContext'] +--- + +# NotificationTemplateContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **map[string]object** | A JSON object that stores the context. | [optional] +**created** | **datetime** | When the global context was created | [optional] +**modified** | **datetime** | When the global context was last modified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.notification_template_context import NotificationTemplateContext + +notification_template_context = NotificationTemplateContext( +attributes={productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}}, +created='2020-04-15T16:16:47.525Z', +modified='2020-04-15T16:16:47.525Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectExportImportNames.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..805b018c7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectExportImportNames.md @@ -0,0 +1,35 @@ +--- +id: v2024-object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectExportImportNames', 'V2024ObjectExportImportNames'] +slug: /tools/sdk/python/v2024/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'V2024ObjectExportImportNames'] +--- + +# ObjectExportImportNames + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**included_names** | **[]str** | Object names to be included in a backup. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.object_export_import_names import ObjectExportImportNames + +object_export_import_names = ObjectExportImportNames( +included_names=[ + 'Test Object name' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectExportImportOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..77d7ace6d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectExportImportOptions.md @@ -0,0 +1,39 @@ +--- +id: v2024-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectExportImportOptions', 'V2024ObjectExportImportOptions'] +slug: /tools/sdk/python/v2024/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'V2024ObjectExportImportOptions'] +--- + +# ObjectExportImportOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**included_ids** | **[]str** | Object ids to be included in an import or export. | [optional] +**included_names** | **[]str** | Object names to be included in an import or export. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.object_export_import_options import ObjectExportImportOptions + +object_export_import_options = ObjectExportImportOptions( +included_ids=[ + 'be9e116d-08e1-49fc-ab7f-fa585e96c9e4' + ], +included_names=[ + 'Test Object' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectImportResult.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectImportResult.md new file mode 100644 index 000000000..94ffbe57e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectImportResult.md @@ -0,0 +1,60 @@ +--- +id: v2024-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectImportResult', 'V2024ObjectImportResult'] +slug: /tools/sdk/python/v2024/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'V2024ObjectImportResult'] +--- + +# ObjectImportResult + +Response model for import of a single object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] +**warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] +**errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] +**imported_objects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.object_import_result import ObjectImportResult + +object_import_result = ObjectImportResult( +infos=[ + sailpoint.v2024.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +warnings=[ + sailpoint.v2024.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +errors=[ + sailpoint.v2024.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +imported_objects=[ + sailpoint.v2024.models.import_object.ImportObject( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectImportResult1.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectImportResult1.md new file mode 100644 index 000000000..65f03b09a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectImportResult1.md @@ -0,0 +1,60 @@ +--- +id: v2024-object-import-result1 +title: ObjectImportResult1 +pagination_label: ObjectImportResult1 +sidebar_label: ObjectImportResult1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectImportResult1', 'V2024ObjectImportResult1'] +slug: /tools/sdk/python/v2024/models/object-import-result1 +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult1', 'V2024ObjectImportResult1'] +--- + +# ObjectImportResult1 + +Response model for import of a single object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**infos** | [**[]SpConfigMessage1**](sp-config-message1) | Informational messages returned from the target service on import. | [required] +**warnings** | [**[]SpConfigMessage1**](sp-config-message1) | Warning messages returned from the target service on import. | [required] +**errors** | [**[]SpConfigMessage1**](sp-config-message1) | Error messages returned from the target service on import. | [required] +**imported_objects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.object_import_result1 import ObjectImportResult1 + +object_import_result1 = ObjectImportResult1( +infos=[ + sailpoint.v2024.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +warnings=[ + sailpoint.v2024.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +errors=[ + sailpoint.v2024.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +imported_objects=[ + sailpoint.v2024.models.import_object.ImportObject( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..e25128dc1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkCreateRequest', 'V2024ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/python/v2024/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'V2024ObjectMappingBulkCreateRequest'] +--- + +# ObjectMappingBulkCreateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_objects_mappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest + +object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest( +new_objects_mappings=[ + sailpoint.v2024.models.object_mapping_request.Object Mapping Request( + object_type = 'IDENTITY', + json_path = '$.name', + source_value = 'My Governance Group Name', + target_value = 'My New Governance Group Name', + enabled = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..d69e9e0a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkCreateResponse', 'V2024ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/python/v2024/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'V2024ObjectMappingBulkCreateResponse'] +--- + +# ObjectMappingBulkCreateResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**added_objects** | [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse + +object_mapping_bulk_create_response = ObjectMappingBulkCreateResponse( +added_objects=[ + sailpoint.v2024.models.object_mapping_response.Object Mapping Response( + object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4', + object_type = 'IDENTITY', + json_path = '$.name', + source_value = 'My Governance Group Name', + target_value = 'My New Governance Group Name', + enabled = False, + created = '2024-03-19T23:18:53.732Z', + modified = '2024-03-19T23:18:53.732Z', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..2dc79520f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/python/v2024/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest'] +--- + +# ObjectMappingBulkPatchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patches** | [**map[string]List[JsonPatchOperation]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest + +object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest( +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}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..e44441d3e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchResponse', 'V2024ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/python/v2024/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'V2024ObjectMappingBulkPatchResponse'] +--- + +# ObjectMappingBulkPatchResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patched_objects** | [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse + +object_mapping_bulk_patch_response = ObjectMappingBulkPatchResponse( +patched_objects=[ + sailpoint.v2024.models.object_mapping_response.Object Mapping Response( + object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4', + object_type = 'IDENTITY', + json_path = '$.name', + source_value = 'My Governance Group Name', + target_value = 'My New Governance Group Name', + enabled = False, + created = '2024-03-19T23:18:53.732Z', + modified = '2024-03-19T23:18:53.732Z', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..852f8a6eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingRequest', 'V2024ObjectMappingRequest'] +slug: /tools/sdk/python/v2024/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'V2024ObjectMappingRequest'] +--- + +# ObjectMappingRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'ENTITLEMENT', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY', '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' ] | Type of the object the mapping value applies to, must be one from enum | [required] +**json_path** | **str** | JSONPath expression denoting the path within the object where the mapping value should be applied | [required] +**source_value** | **str** | Original value at the jsonPath location within the object | [required] +**target_value** | **str** | Value to be assigned at the jsonPath location within the object | [required] +**enabled** | **bool** | Whether or not this object mapping is enabled | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.object_mapping_request import ObjectMappingRequest + +object_mapping_request = ObjectMappingRequest( +object_type='IDENTITY', +json_path='$.name', +source_value='My Governance Group Name', +target_value='My New Governance Group Name', +enabled=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..a4bcd31fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ObjectMappingResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingResponse', 'V2024ObjectMappingResponse'] +slug: /tools/sdk/python/v2024/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'V2024ObjectMappingResponse'] +--- + +# ObjectMappingResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_mapping_id** | **str** | Id of the object mapping | [optional] +**object_type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'ENTITLEMENT', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY', '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' ] | Type of the object the mapping value applies to | [optional] +**json_path** | **str** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**source_value** | **str** | Original value at the jsonPath location within the object | [optional] +**target_value** | **str** | Value to be assigned at the jsonPath location within the object | [optional] +**enabled** | **bool** | Whether or not this object mapping is enabled | [optional] [default to False] +**created** | **str** | Object mapping creation timestamp | [optional] +**modified** | **str** | Object mapping latest update timestamp | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse + +object_mapping_response = ObjectMappingResponse( +object_mapping_id='3d6e0144-963f-4bd6-8d8d-d77b4e507ce4', +object_type='IDENTITY', +json_path='$.name', +source_value='My Governance Group Name', +target_value='My New Governance Group Name', +enabled=False, +created='2024-03-19T23:18:53.732Z', +modified='2024-03-19T23:18:53.732Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Operation.md b/docs/tools/sdk/python/Reference/V2024/Models/Operation.md new file mode 100644 index 000000000..bd1825f5f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Operation.md @@ -0,0 +1,33 @@ +--- +id: v2024-operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Operation', 'V2024Operation'] +slug: /tools/sdk/python/v2024/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'V2024Operation'] +--- + +# Operation + +Operation on a specific criteria + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `STARTS_WITH` (value: `'STARTS_WITH'`) + +* `ENDS_WITH` (value: `'ENDS_WITH'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OrgConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/OrgConfig.md new file mode 100644 index 000000000..52d7f59a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OrgConfig.md @@ -0,0 +1,58 @@ +--- +id: v2024-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OrgConfig', 'V2024OrgConfig'] +slug: /tools/sdk/python/v2024/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2024OrgConfig'] +--- + +# OrgConfig + +DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**org_name** | **str** | The name of the org. | [optional] +**time_zone** | **str** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**lcs_change_honors_source_enable_feature** | **bool** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**arm_customer_id** | **str** | ARM Customer ID | [optional] +**arm_sap_system_id_mappings** | **str** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**arm_auth** | **str** | ARM authentication string | [optional] +**arm_db** | **str** | ARM database name | [optional] +**arm_sso_url** | **str** | ARM SSO URL | [optional] +**iai_enable_certification_recommendations** | **bool** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**sod_report_configs** | [**[]ReportConfigDTO**](report-config-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.org_config import OrgConfig + +org_config = OrgConfig( +org_name='acme-solar', +time_zone='America/Toronto', +lcs_change_honors_source_enable_feature=False, +arm_customer_id='DE38E75A-5FF6-4A65-5DC7-08D64426B09E', +arm_sap_system_id_mappings='[{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}]', +arm_auth='epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag==', +arm_db='EU', +arm_sso_url='https://your-arm-sso-url', +iai_enable_certification_recommendations=True, +sod_report_configs=[ + sailpoint.v2024.models.report_config_dto.ReportConfigDTO( + column_name = 'SOD Business Name', + required = True, + included = False, + order = 2, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OriginalRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/OriginalRequest.md new file mode 100644 index 000000000..87003cd79 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OriginalRequest.md @@ -0,0 +1,47 @@ +--- +id: v2024-original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OriginalRequest', 'V2024OriginalRequest'] +slug: /tools/sdk/python/v2024/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'V2024OriginalRequest'] +--- + +# OriginalRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Account ID. | [optional] +**result** | [**Result**](result) | | [optional] +**attribute_requests** | [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**op** | **str** | Operation used. | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.original_request import OriginalRequest + +original_request = OriginalRequest( +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +result=sailpoint.v2024.models.result.Result( + status = 'Manual Task Created', ), +attribute_requests=[ + sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], +op='add', +source= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..f09189360 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,34 @@ +--- +id: v2024-orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OrphanIdentitiesReportArguments', 'V2024OrphanIdentitiesReportArguments'] +slug: /tools/sdk/python/v2024/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'V2024OrphanIdentitiesReportArguments'] +--- + +# OrphanIdentitiesReportArguments + +Arguments for Orphan Identities report (ORPHAN_IDENTITIES) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selected_formats** | **[]str** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.orphan_identities_report_arguments import OrphanIdentitiesReportArguments + +orphan_identities_report_arguments = OrphanIdentitiesReportArguments( +selected_formats=[CSV] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Outlier.md b/docs/tools/sdk/python/Reference/V2024/Models/Outlier.md new file mode 100644 index 000000000..e144e237d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Outlier.md @@ -0,0 +1,53 @@ +--- +id: v2024-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Outlier', 'V2024Outlier'] +slug: /tools/sdk/python/v2024/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'V2024Outlier'] +--- + +# Outlier + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity's unique identifier for the outlier record | [optional] +**identity_id** | **str** | The ID of the identity that is detected as an outlier | [optional] +**type** | **Enum** [ 'LOW_SIMILARITY', 'STRUCTURAL' ] | The type of outlier summary | [optional] +**first_detection_date** | **datetime** | The first date the outlier was detected | [optional] +**latest_detection_date** | **datetime** | The most recent date the outlier was detected | [optional] +**ignored** | **bool** | Flag whether or not the outlier has been ignored | [optional] +**attributes** | **object** | Object containing mapped identity attributes | [optional] +**score** | **float** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**unignore_type** | **Enum** [ 'MANUAL', 'AUTOMATIC' ] | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**unignore_date** | **datetime** | shows date when last time has been unignored outlier | [optional] +**ignore_date** | **datetime** | shows date when last time has been ignored outlier | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.outlier import Outlier + +outlier = Outlier( +id='5be33d3e-c54d-4ed7-af73-2380543e8283', +identity_id='5be33d3e-c54d-4ed7-af73-2380543e8283', +type='LOW_SIMILARITY', +first_detection_date='2021-05-01T18:40:35.772Z', +latest_detection_date='2021-05-03T18:40:35.772Z', +ignored=False, +attributes={displayName=John Smith, jobTitle=Software Engineer, department=Engineering}, +score=0.92, +unignore_type='MANUAL', +unignore_date='2021-06-01T18:40:35.772Z', +ignore_date='2021-06-01T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutlierContributingFeature.md b/docs/tools/sdk/python/Reference/V2024/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..c942f86e1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutlierContributingFeature.md @@ -0,0 +1,55 @@ +--- +id: v2024-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierContributingFeature', 'V2024OutlierContributingFeature'] +slug: /tools/sdk/python/v2024/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'V2024OutlierContributingFeature'] +--- + +# OutlierContributingFeature + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Contributing feature id | [optional] +**name** | **str** | The name of the feature | [optional] +**value_type** | [**OutlierValueType**](outlier-value-type) | | [optional] +**value** | **float** | The feature value | [optional] +**importance** | **float** | The importance of the feature. This can also be a negative value | [optional] +**display_name** | **str** | The (translated if header is passed) displayName for the feature | [optional] +**description** | **str** | The (translated if header is passed) description for the feature | [optional] +**translation_messages** | [**OutlierFeatureTranslation**](outlier-feature-translation) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.outlier_contributing_feature import OutlierContributingFeature + +outlier_contributing_feature = OutlierContributingFeature( +id='66e38828-5017-47af-92ff-9844871352c5', +name='entitlement_count', +value_type=sailpoint.v2024.models.outlier_value_type.OutlierValueType( + name = 'INTEGER', + ordinal = 0, ), +value=1.0, +importance=-0.15, +display_name='Number of entitlements', +description='The total number of entitlements belonging to an identity', +translation_messages=sailpoint.v2024.models.outlier_feature_translation.OutlierFeatureTranslation( + display_name = sailpoint.v2024.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ), + description = sailpoint.v2024.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..2460b1db6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureSummary.md @@ -0,0 +1,54 @@ +--- +id: v2024-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierFeatureSummary', 'V2024OutlierFeatureSummary'] +slug: /tools/sdk/python/v2024/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'V2024OutlierFeatureSummary'] +--- + +# OutlierFeatureSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contributing_feature_name** | **str** | Contributing feature name | [optional] +**identity_outlier_display_name** | **str** | Identity display name | [optional] +**outlier_feature_display_values** | [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**feature_definition** | **str** | Definition of the feature | [optional] +**feature_explanation** | **str** | Detailed explanation of the feature | [optional] +**peer_display_name** | **str** | outlier's peer identity display name | [optional] +**peer_identity_id** | **str** | outlier's peer identity id | [optional] +**access_item_reference** | **object** | Access Item reference | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.outlier_feature_summary import OutlierFeatureSummary + +outlier_feature_summary = OutlierFeatureSummary( +contributing_feature_name='Rare Access', +identity_outlier_display_name='John Smith', +outlier_feature_display_values=[ + sailpoint.v2024.models.outlier_feature_summary_outlier_feature_display_values_inner.OutlierFeatureSummary_outlierFeatureDisplayValues_inner( + display_name = 'Aliza Chris', + value = '55', + value_type = sailpoint.v2024.models.outlier_value_type.OutlierValueType( + name = 'INTEGER', + ordinal = 0, ), ) + ], +feature_definition='Identity total number of entitlements', +feature_explanation='An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess', +peer_display_name='Mary Jane', +peer_identity_id='9f9d5d53ad0e48fba7352f6da9f1b8gbg', +access_item_reference={displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..cefff417b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/python/v2024/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_name** | **str** | display name | [optional] +**value** | **str** | value | [optional] +**value_type** | [**OutlierValueType**](outlier-value-type) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.outlier_feature_summary_outlier_feature_display_values_inner import OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +outlier_feature_summary_outlier_feature_display_values_inner = OutlierFeatureSummaryOutlierFeatureDisplayValuesInner( +display_name='Aliza Chris', +value='55', +value_type=sailpoint.v2024.models.outlier_value_type.OutlierValueType( + name = 'INTEGER', + ordinal = 0, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..d7d0a877b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutlierFeatureTranslation.md @@ -0,0 +1,39 @@ +--- +id: v2024-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierFeatureTranslation', 'V2024OutlierFeatureTranslation'] +slug: /tools/sdk/python/v2024/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'V2024OutlierFeatureTranslation'] +--- + +# OutlierFeatureTranslation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_name** | [**TranslationMessage**](translation-message) | | [optional] +**description** | [**TranslationMessage**](translation-message) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.outlier_feature_translation import OutlierFeatureTranslation + +outlier_feature_translation = OutlierFeatureTranslation( +display_name=sailpoint.v2024.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ), +description=sailpoint.v2024.models.translation_message.TranslationMessage( + key = 'recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', + values = [75, department], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutlierSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/OutlierSummary.md new file mode 100644 index 000000000..ff39e2f51 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutlierSummary.md @@ -0,0 +1,41 @@ +--- +id: v2024-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierSummary', 'V2024OutlierSummary'] +slug: /tools/sdk/python/v2024/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'V2024OutlierSummary'] +--- + +# OutlierSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LOW_SIMILARITY', 'STRUCTURAL' ] | The type of outlier summary | [optional] +**snapshot_date** | **datetime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**total_outliers** | **int** | Total number of outliers for the customer making the request | [optional] +**total_identities** | **int** | Total number of identities for the customer making the request | [optional] +**total_ignored** | **int** | | [optional] [default to 0] +} + +## Example + +```python +from sailpoint.v2024.models.outlier_summary import OutlierSummary + +outlier_summary = OutlierSummary( +type='LOW_SIMILARITY', +snapshot_date='2021-05-01T18:40:35.772Z', +total_outliers=50, +total_identities=5000, +total_ignored=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutlierValueType.md b/docs/tools/sdk/python/Reference/V2024/Models/OutlierValueType.md new file mode 100644 index 000000000..6cd3942fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutlierValueType.md @@ -0,0 +1,36 @@ +--- +id: v2024-outlier-value-type +title: OutlierValueType +pagination_label: OutlierValueType +sidebar_label: OutlierValueType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutlierValueType', 'V2024OutlierValueType'] +slug: /tools/sdk/python/v2024/models/outlier-value-type +tags: ['SDK', 'Software Development Kit', 'OutlierValueType', 'V2024OutlierValueType'] +--- + +# OutlierValueType + +The data type of the value field + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Enum** [ 'INTEGER', 'FLOAT' ] | The data type of the value field | [optional] +**ordinal** | **int** | The position of the value type | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.outlier_value_type import OutlierValueType + +outlier_value_type = OutlierValueType( +name='INTEGER', +ordinal=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/python/Reference/V2024/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..decdf90fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,43 @@ +--- +id: v2024-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OutliersContributingFeatureAccessItems', 'V2024OutliersContributingFeatureAccessItems'] +slug: /tools/sdk/python/v2024/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'V2024OutliersContributingFeatureAccessItems'] +--- + +# OutliersContributingFeatureAccessItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the access item | [optional] +**display_name** | **str** | the display name of the access item | [optional] +**description** | **str** | Description of the access item. | [optional] +**access_type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | The type of the access item. | [optional] +**source_name** | **str** | the associated source name if it exists | [optional] +**extremely_rare** | **bool** | rarest access | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems + +outliers_contributing_feature_access_items = OutliersContributingFeatureAccessItems( +id='2c938083633d259901633d2623ec0375', +display_name='Applied Research Access', +description='Access to research information, lab results, and schematics', +access_type='ENTITLEMENT', +source_name='appName', +extremely_rare=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OwnerDto.md b/docs/tools/sdk/python/Reference/V2024/Models/OwnerDto.md new file mode 100644 index 000000000..418b33e91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OwnerDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerDto', 'V2024OwnerDto'] +slug: /tools/sdk/python/v2024/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'V2024OwnerDto'] +--- + +# OwnerDto + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.owner_dto import OwnerDto + +owner_dto = OwnerDto( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md new file mode 100644 index 000000000..c756a45f4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md @@ -0,0 +1,38 @@ +--- +id: v2024-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReference', 'V2024OwnerReference'] +slug: /tools/sdk/python/v2024/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference'] +--- + +# OwnerReference + +The owner of this object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.owner_reference import OwnerReference + +owner_reference = OwnerReference( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OwnerReferenceSegments.md b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..682a7cd20 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReferenceSegments.md @@ -0,0 +1,38 @@ +--- +id: v2024-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReferenceSegments', 'V2024OwnerReferenceSegments'] +slug: /tools/sdk/python/v2024/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'V2024OwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +The owner of this object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.owner_reference_segments import OwnerReferenceSegments + +owner_reference_segments = OwnerReferenceSegments( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Owns.md b/docs/tools/sdk/python/Reference/V2024/Models/Owns.md new file mode 100644 index 000000000..cf47e39e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Owns.md @@ -0,0 +1,69 @@ +--- +id: v2024-owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Owns', 'V2024Owns'] +slug: /tools/sdk/python/v2024/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'V2024Owns'] +--- + +# Owns + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sources** | [**[]Reference**](reference) | | [optional] +**entitlements** | [**[]Reference**](reference) | | [optional] +**access_profiles** | [**[]Reference**](reference) | | [optional] +**roles** | [**[]Reference**](reference) | | [optional] +**apps** | [**[]Reference**](reference) | | [optional] +**governance_groups** | [**[]Reference**](reference) | | [optional] +**fallback_approver** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.owns import Owns + +owns = Owns( +sources=[ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +entitlements=[ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +access_profiles=[ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +roles=[ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +apps=[ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +governance_groups=[ + sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +fallback_approver=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordChangeRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..ef8f19bf7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordChangeRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordChangeRequest', 'V2024PasswordChangeRequest'] +slug: /tools/sdk/python/v2024/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'V2024PasswordChangeRequest'] +--- + +# PasswordChangeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID that requested the password change | [optional] +**encrypted_password** | **str** | The RSA encrypted password | [optional] +**public_key_id** | **str** | The encryption key ID | [optional] +**account_id** | **str** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**source_id** | **str** | The ID of the source for which identity is requesting the password change | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_change_request import PasswordChangeRequest + +password_change_request = PasswordChangeRequest( +identity_id='8a807d4c73c545510173c545f0a002ff', +encrypted_password='XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==', +public_key_id='YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2', +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +source_id='8a807d4c73c545510173c545d4b60246' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordChangeResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..711655ed3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordChangeResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordChangeResponse', 'V2024PasswordChangeResponse'] +slug: /tools/sdk/python/v2024/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'V2024PasswordChangeResponse'] +--- + +# PasswordChangeResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The password change request ID | [optional] +**state** | **Enum** [ 'IN_PROGRESS', 'FINISHED', 'FAILED' ] | Password change state | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_change_response import PasswordChangeResponse + +password_change_response = PasswordChangeResponse( +request_id='089899f13a8f4da7824996191587bab9', +state='IN_PROGRESS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordDigitToken.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordDigitToken.md new file mode 100644 index 000000000..c923407de --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordDigitToken.md @@ -0,0 +1,35 @@ +--- +id: v2024-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordDigitToken', 'V2024PasswordDigitToken'] +slug: /tools/sdk/python/v2024/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'V2024PasswordDigitToken'] +--- + +# PasswordDigitToken + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**digit_token** | **str** | The digit token for password management | [optional] +**request_id** | **str** | The reference ID of the digit token generation request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_digit_token import PasswordDigitToken + +password_digit_token = PasswordDigitToken( +digit_token='09087713', +request_id='e1267ecd-fcd9-4c73-9c55-12555efad136' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..8e0eea0c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordDigitTokenReset.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordDigitTokenReset', 'V2024PasswordDigitTokenReset'] +slug: /tools/sdk/python/v2024/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'V2024PasswordDigitTokenReset'] +--- + +# PasswordDigitTokenReset + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | The uid of the user requested for digit token | [required] +**length** | **int** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**duration_minutes** | **int** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_digit_token_reset import PasswordDigitTokenReset + +password_digit_token_reset = PasswordDigitTokenReset( +user_id='Abby.Smith', +length=8, +duration_minutes=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfo.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfo.md new file mode 100644 index 000000000..b0b38866a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfo.md @@ -0,0 +1,47 @@ +--- +id: v2024-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfo', 'V2024PasswordInfo'] +slug: /tools/sdk/python/v2024/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'V2024PasswordInfo'] +--- + +# PasswordInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity ID | [optional] +**source_id** | **str** | source ID | [optional] +**public_key_id** | **str** | public key ID | [optional] +**public_key** | **str** | User's public key with Base64 encoding | [optional] +**accounts** | [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**policies** | **[]str** | Password constraints | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_info import PasswordInfo + +password_info = PasswordInfo( +identity_id='2c918085744fec4301746f9a5bce4605', +source_id='2c918083746f642c01746f990884012a', +public_key_id='N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh', +public_key='MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB', +accounts=[ + sailpoint.v2024.models.password_info_account.PasswordInfoAccount( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + account_name = 'Abby.Smith', ) + ], +policies=[passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfoAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..4a5200f5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfoAccount.md @@ -0,0 +1,35 @@ +--- +id: v2024-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfoAccount', 'V2024PasswordInfoAccount'] +slug: /tools/sdk/python/v2024/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'V2024PasswordInfoAccount'] +--- + +# PasswordInfoAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**account_name** | **str** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_info_account import PasswordInfoAccount + +password_info_account = PasswordInfoAccount( +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +account_name='Abby.Smith' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..94264ce51 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,35 @@ +--- +id: v2024-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfoQueryDTO', 'V2024PasswordInfoQueryDTO'] +slug: /tools/sdk/python/v2024/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'V2024PasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | The login name of the user | [optional] +**source_name** | **str** | The display name of the source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_info_query_dto import PasswordInfoQueryDTO + +password_info_query_dto = PasswordInfoQueryDTO( +user_name='Abby.Smith', +source_name='My-AD' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordOrgConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..0061c8de1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordOrgConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordOrgConfig', 'V2024PasswordOrgConfig'] +slug: /tools/sdk/python/v2024/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'V2024PasswordOrgConfig'] +--- + +# PasswordOrgConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**custom_instructions_enabled** | **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to False] +**digit_token_enabled** | **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to False] +**digit_token_duration_minutes** | **int** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**digit_token_length** | **int** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] +} + +## Example + +```python +from sailpoint.v2024.models.password_org_config import PasswordOrgConfig + +password_org_config = PasswordOrgConfig( +custom_instructions_enabled=True, +digit_token_enabled=True, +digit_token_duration_minutes=10, +digit_token_length=9 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributes.md new file mode 100644 index 000000000..67aac660f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributes.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-policy-holders-dto-attributes +title: PasswordPolicyHoldersDtoAttributes +pagination_label: PasswordPolicyHoldersDtoAttributes +sidebar_label: PasswordPolicyHoldersDtoAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordPolicyHoldersDtoAttributes', 'V2024PasswordPolicyHoldersDtoAttributes'] +slug: /tools/sdk/python/v2024/models/password-policy-holders-dto-attributes +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributes', 'V2024PasswordPolicyHoldersDtoAttributes'] +--- + +# PasswordPolicyHoldersDtoAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attr** | [**[]PasswordPolicyHoldersDtoAttributesIdentityAttrInner**](password-policy-holders-dto-attributes-identity-attr-inner) | Attributes of PasswordPolicyHoldersDto | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_policy_holders_dto_attributes import PasswordPolicyHoldersDtoAttributes + +password_policy_holders_dto_attributes = PasswordPolicyHoldersDtoAttributes( +identity_attr=[ + sailpoint.v2024.models.password_policy_holders_dto_attributes_identity_attr_inner.PasswordPolicyHoldersDtoAttributes_identityAttr_inner( + name = 'Country', + value = 'Canada', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md new file mode 100644 index 000000000..66f098f6b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-password-policy-holders-dto-attributes-identity-attr-inner +title: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +pagination_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +slug: /tools/sdk/python/v2024/models/password-policy-holders-dto-attributes-identity-attr-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +--- + +# PasswordPolicyHoldersDtoAttributesIdentityAttrInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Attribute's name | [optional] +**value** | **str** | Attribute's value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_policy_holders_dto_attributes_identity_attr_inner import PasswordPolicyHoldersDtoAttributesIdentityAttrInner + +password_policy_holders_dto_attributes_identity_attr_inner = PasswordPolicyHoldersDtoAttributesIdentityAttrInner( +name='Country', +value='Canada' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md new file mode 100644 index 000000000..69048b16e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-policy-holders-dto-inner +title: PasswordPolicyHoldersDtoInner +pagination_label: PasswordPolicyHoldersDtoInner +sidebar_label: PasswordPolicyHoldersDtoInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordPolicyHoldersDtoInner', 'V2024PasswordPolicyHoldersDtoInner'] +slug: /tools/sdk/python/v2024/models/password-policy-holders-dto-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoInner', 'V2024PasswordPolicyHoldersDtoInner'] +--- + +# PasswordPolicyHoldersDtoInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy_id** | **str** | The password policy Id. | [optional] +**policy_name** | **str** | The name of the password policy. | [optional] +**selectors** | [**PasswordPolicyHoldersDtoAttributes**](password-policy-holders-dto-attributes) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_policy_holders_dto_inner import PasswordPolicyHoldersDtoInner + +password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner( +policy_id='2c91808e7d976f3b017d9f5ceae440c8', +policy_name='PasswordPolicy Example', +selectors={identityAttr=[{name=displayName, value=Robert}, {name=lastname, value=Juice}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..ae1c0234b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,93 @@ +--- +id: v2024-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordPolicyV3Dto', 'V2024PasswordPolicyV3Dto'] +slug: /tools/sdk/python/v2024/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'V2024PasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The password policy Id. | [optional] +**description** | **str** | Description for current password policy. | [optional] +**name** | **str** | The name of the password policy. | [optional] +**date_created** | **int** | Date the Password Policy was created. | [optional] +**last_updated** | **int** | Date the Password Policy was updated. | [optional] +**first_expiration_reminder** | **int** | The number of days before expiration remaninder. | [optional] +**account_id_min_word_length** | **int** | The minimun length of account Id. By default is equals to -1. | [optional] +**account_name_min_word_length** | **int** | The minimun length of account name. By default is equals to -1. | [optional] +**min_alpha** | **int** | Maximum alpha. By default is equals to 0. | [optional] +**min_character_types** | **int** | MinCharacterTypes. By default is equals to -1. | [optional] +**max_length** | **int** | Maximum length of the password. | [optional] +**min_length** | **int** | Minimum length of the password. By default is equals to 0. | [optional] +**max_repeated_chars** | **int** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**min_lower** | **int** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**min_numeric** | **int** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**min_special** | **int** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**min_upper** | **int** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**password_expiration** | **int** | Number of days before current password expires. By default is equals to 90. | [optional] +**default_policy** | **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to False] +**enable_passwd_expiration** | **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to False] +**require_strong_authn** | **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to False] +**require_strong_auth_off_network** | **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to False] +**require_strong_auth_untrusted_geographies** | **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to False] +**use_account_attributes** | **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to False] +**use_dictionary** | **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to False] +**use_identity_attributes** | **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to False] +**validate_against_account_id** | **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to False] +**validate_against_account_name** | **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to False] +**created** | **str** | | [optional] +**modified** | **str** | | [optional] +**source_ids** | **[]str** | List of sources IDs managed by this password policy. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto + +password_policy_v3_dto = PasswordPolicyV3Dto( +id='2c91808e7d976f3b017d9f5ceae440c8', +description='Information about the Password Policy', +name='PasswordPolicy Example', +date_created=1639056206564, +last_updated=1939056206564, +first_expiration_reminder=45, +account_id_min_word_length=4, +account_name_min_word_length=6, +min_alpha=5, +min_character_types=5, +max_length=25, +min_length=8, +max_repeated_chars=3, +min_lower=8, +min_numeric=8, +min_special=8, +min_upper=8, +password_expiration=8, +default_policy=True, +enable_passwd_expiration=True, +require_strong_authn=True, +require_strong_auth_off_network=True, +require_strong_auth_untrusted_geographies=True, +use_account_attributes=False, +use_dictionary=False, +use_identity_attributes=False, +validate_against_account_id=False, +validate_against_account_name=True, +created='', +modified='', +source_ids=[2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordStatus.md new file mode 100644 index 000000000..5bf692614 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordStatus.md @@ -0,0 +1,39 @@ +--- +id: v2024-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordStatus', 'V2024PasswordStatus'] +slug: /tools/sdk/python/v2024/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'V2024PasswordStatus'] +--- + +# PasswordStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The password change request ID | [optional] +**state** | **Enum** [ 'IN_PROGRESS', 'FINISHED', 'FAILED' ] | Password change state | [optional] +**errors** | **[]str** | The errors during the password change request | [optional] +**source_ids** | **[]str** | List of source IDs in the password change request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_status import PasswordStatus + +password_status = PasswordStatus( +request_id='089899f13a8f4da7824996191587bab9', +state='IN_PROGRESS', +errors=[The password change payload is invalid], +source_ids=[2c918083746f642c01746f990884012a] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PasswordSyncGroup.md b/docs/tools/sdk/python/Reference/V2024/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..f3ee8dffb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PasswordSyncGroup.md @@ -0,0 +1,43 @@ +--- +id: v2024-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordSyncGroup', 'V2024PasswordSyncGroup'] +slug: /tools/sdk/python/v2024/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'V2024PasswordSyncGroup'] +--- + +# PasswordSyncGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the sync group | [optional] +**name** | **str** | Name of the sync group | [optional] +**password_policy_id** | **str** | ID of the password policy | [optional] +**source_ids** | **[]str** | List of password managed sources IDs | [optional] +**created** | **datetime** | The date and time this sync group was created | [optional] +**modified** | **datetime** | The date and time this sync group was last modified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup + +password_sync_group = PasswordSyncGroup( +id='6881f631-3bd5-4213-9c75-8e05cc3e35dd', +name='Password Sync Group 1', +password_policy_id='2c91808d744ba0ce01746f93b6204501', +source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], +created='2023-03-16T04:00Z', +modified='2023-03-16T04:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PatOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/PatOwner.md new file mode 100644 index 000000000..b0c0bfa97 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PatOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatOwner', 'V2024PatOwner'] +slug: /tools/sdk/python/v2024/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'V2024PatOwner'] +--- + +# PatOwner + +Personal access token owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Personal access token owner's DTO type. | [optional] +**id** | **str** | Personal access token owner's identity ID. | [optional] +**name** | **str** | Personal access token owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.pat_owner import PatOwner + +pat_owner = PatOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/python/Reference/V2024/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..8aaea9318 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatchPotentialRoleRequestInner', 'V2024PatchPotentialRoleRequestInner'] +slug: /tools/sdk/python/v2024/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'V2024PatchPotentialRoleRequestInner'] +--- + +# PatchPotentialRoleRequestInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'remove', 'replace' ] | The operation to be performed | [optional] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner + +patch_potential_role_request_inner = PatchPotentialRoleRequestInner( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md new file mode 100644 index 000000000..1d36a030c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md @@ -0,0 +1,39 @@ +--- +id: v2024-patch-service-desk-integration-request +title: PatchServiceDeskIntegrationRequest +pagination_label: PatchServiceDeskIntegrationRequest +sidebar_label: PatchServiceDeskIntegrationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] +slug: /tools/sdk/python/v2024/models/patch-service-desk-integration-request +tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] +--- + +# PatchServiceDeskIntegrationRequest + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + +patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( +operations=[ + sailpoint.v2024.models.json_patch_operation.JsonPatchOperation( + op = 'replace', + path = '/description', + value = New description, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PeerGroupMember.md b/docs/tools/sdk/python/Reference/V2024/Models/PeerGroupMember.md new file mode 100644 index 000000000..788348135 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PeerGroupMember.md @@ -0,0 +1,41 @@ +--- +id: v2024-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PeerGroupMember', 'V2024PeerGroupMember'] +slug: /tools/sdk/python/v2024/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'V2024PeerGroupMember'] +--- + +# PeerGroupMember + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier for the peer group member. | [optional] +**type** | **str** | The type of the peer group member. | [optional] +**peer_group_id** | **str** | The ID of the peer group. | [optional] +**attributes** | **map[string]object** | Arbitrary key-value pairs, belonging to the peer group member. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.peer_group_member import PeerGroupMember + +peer_group_member = PeerGroupMember( +id='', +type='', +peer_group_id='', +attributes={ + 'key' : None + } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PendingApproval.md b/docs/tools/sdk/python/Reference/V2024/Models/PendingApproval.md new file mode 100644 index 000000000..0f70f9d0f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PendingApproval.md @@ -0,0 +1,136 @@ +--- +id: v2024-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApproval', 'V2024PendingApproval'] +slug: /tools/sdk/python/v2024/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2024PendingApproval'] +--- + +# PendingApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval id. | [optional] +**access_request_id** | **str** | This is the access request id. | [optional] +**name** | **str** | The name of the approval. | [optional] +**created** | **datetime** | When the approval was created. | [optional] +**modified** | **datetime** | When the approval was modified last time. | [optional] +**request_created** | **datetime** | When the access-request was created. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**AccessItemRequestedFor**](access-item-requested-for) | | [optional] +**owner** | [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**requested_object** | [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**requester_comment** | [**CommentDto**](comment-dto) | | [optional] +**previous_reviewers_comments** | [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**comment_required_when_rejected** | **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to False] +**action_in_process** | [**PendingApprovalAction**](pending-approval-action) | | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**remove_date_update_requested** | **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to False] +**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**sod_violation_context** | [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.pending_approval import PendingApproval + +pending_approval = PendingApproval( +id='id12345', +access_request_id='2b838de9db9babcfe646d4f274ad4238', +name='aName', +created='2017-07-11T18:45:37.098Z', +modified='2018-07-25T20:22:28.104Z', +request_created='2017-07-11T18:45:35.098Z', +request_type='GRANT_ACCESS', +requester=sailpoint.v2024.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v2024.models.access_item_requested_for.AccessItemRequestedFor( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ), +owner=sailpoint.v2024.models.pending_approval_owner.PendingApproval_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +requested_object=sailpoint.v2024.models.requestable_object_reference.RequestableObjectReference( + id = '2c9180835d2e5168015d32f890ca1581', + name = 'Applied Research Access', + description = 'Access to research information, lab results, and schematics', + type = 'ROLE', ), +requester_comment=sailpoint.v2024.models.comment_dto.CommentDto( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ), +previous_reviewers_comments=[ + sailpoint.v2024.models.comment_dto.CommentDto( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ) + ], +forward_history=[ + sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], +comment_required_when_rejected=True, +action_in_process='APPROVED', +remove_date='2020-07-11T00:00Z', +remove_date_update_requested=True, +current_remove_date='2020-07-11T00:00Z', +sod_violation_context=sailpoint.v2024.models.sod_violation_context_check_completed.SodViolationContextCheckCompleted( + state = 'SUCCESS', + uuid = 'f73d16e9-a038-46c5-b217-1246e15fdbdd', + violation_check_result = sailpoint.v2024.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v2024.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PendingApprovalAction.md b/docs/tools/sdk/python/Reference/V2024/Models/PendingApprovalAction.md new file mode 100644 index 000000000..2768af648 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PendingApprovalAction.md @@ -0,0 +1,25 @@ +--- +id: v2024-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApprovalAction', 'V2024PendingApprovalAction'] +slug: /tools/sdk/python/v2024/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'V2024PendingApprovalAction'] +--- + +# PendingApprovalAction + +Enum represents action that is being processed on an approval. + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `FORWARDED` (value: `'FORWARDED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PendingApprovalOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..acdf6dca1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PendingApprovalOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApprovalOwner', 'V2024PendingApprovalOwner'] +slug: /tools/sdk/python/v2024/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'V2024PendingApprovalOwner'] +--- + +# PendingApprovalOwner + +Access item owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item owner's DTO type. | [optional] +**id** | **str** | Access item owner's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.pending_approval_owner import PendingApprovalOwner + +pending_approval_owner = PendingApprovalOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PermissionDto.md b/docs/tools/sdk/python/Reference/V2024/Models/PermissionDto.md new file mode 100644 index 000000000..d6552981d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PermissionDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PermissionDto', 'V2024PermissionDto'] +slug: /tools/sdk/python/v2024/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'V2024PermissionDto'] +--- + +# PermissionDto + +Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**target** | **str** | The target the permission would grants rights on. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.permission_dto import PermissionDto + +permission_dto = PermissionDto( +rights=[ + 'SELECT' + ], +target='SYS.GV_$TRANSACTION' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..5ddb33353 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,38 @@ +--- +id: v2024-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreApprovalTriggerDetails', 'V2024PreApprovalTriggerDetails'] +slug: /tools/sdk/python/v2024/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'V2024PreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +Provides additional details about the pre-approval trigger for this request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment left for the pre-approval decision | [optional] +**reviewer** | **str** | The reviewer of the pre-approval decision | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | The decision of the pre-approval trigger | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.pre_approval_trigger_details import PreApprovalTriggerDetails + +pre_approval_trigger_details = PreApprovalTriggerDetails( +comment='Access is Approved', +reviewer='John Doe', +decision='APPROVED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PreferencesDto.md b/docs/tools/sdk/python/Reference/V2024/Models/PreferencesDto.md new file mode 100644 index 000000000..adb6afc7a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PreferencesDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreferencesDto', 'V2024PreferencesDto'] +slug: /tools/sdk/python/v2024/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'V2024PreferencesDto'] +--- + +# PreferencesDto + +Maps an Identity's attribute key to a list of preferred notification mediums. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The template notification key. | [optional] +**mediums** | [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**modified** | **datetime** | Modified date of preference | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.preferences_dto import PreferencesDto + +preferences_dto = PreferencesDto( +key='cloud_manual_work_item_summary', +mediums=[EMAIL], +modified='2020-05-15T14:37:06.909Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..09a305139 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PreviewDataSourceResponse.md @@ -0,0 +1,34 @@ +--- +id: v2024-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreviewDataSourceResponse', 'V2024PreviewDataSourceResponse'] +slug: /tools/sdk/python/v2024/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'V2024PreviewDataSourceResponse'] +--- + +# PreviewDataSourceResponse + +PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.preview_data_source_response import PreviewDataSourceResponse + +preview_data_source_response = PreviewDataSourceResponse( +results={"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"}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..1388d6e7d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProcessIdentitiesRequest', 'V2024ProcessIdentitiesRequest'] +slug: /tools/sdk/python/v2024/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'V2024ProcessIdentitiesRequest'] +--- + +# ProcessIdentitiesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_ids** | **[]str** | List of up to 250 identity IDs to process. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.process_identities_request import ProcessIdentitiesRequest + +process_identities_request = ProcessIdentitiesRequest( +identity_ids=[ + 'ef38f94347e94562b5bb8424a56397d8' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProcessingDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/ProcessingDetails.md new file mode 100644 index 000000000..05b6975b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProcessingDetails.md @@ -0,0 +1,41 @@ +--- +id: v2024-processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProcessingDetails', 'V2024ProcessingDetails'] +slug: /tools/sdk/python/v2024/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'V2024ProcessingDetails'] +--- + +# ProcessingDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **datetime** | A date-time in ISO-8601 format | [optional] +**stage** | **str** | | [optional] +**retry_count** | **int** | | [optional] +**stack_trace** | **str** | | [optional] +**message** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.processing_details import ProcessingDetails + +processing_details = ProcessingDetails( +var_date='2018-06-25T20:22:28.104Z', +stage='In Process', +retry_count=0, +stack_trace='', +message='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Product.md b/docs/tools/sdk/python/Reference/V2024/Models/Product.md new file mode 100644 index 000000000..a5727c0d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Product.md @@ -0,0 +1,67 @@ +--- +id: v2024-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Product', 'V2024Product'] +slug: /tools/sdk/python/v2024/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'V2024Product'] +--- + +# Product + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_name** | **str** | Name of the Product | [optional] +**url** | **str** | URL of the Product | [optional] +**product_tenant_id** | **str** | An identifier for a specific product-tenant combination | [optional] +**product_region** | **str** | Product region | [optional] +**product_right** | **str** | Right needed for the Product | [optional] +**api_url** | **str** | API URL of the Product | [optional] +**licenses** | [**[]License**](license) | | [optional] +**attributes** | **map[string]object** | Additional attributes for a product | [optional] +**zone** | **str** | Zone | [optional] +**status** | **str** | Status of the product | [optional] +**status_date_time** | **datetime** | Status datetime | [optional] +**reason** | **str** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**notes** | **str** | Product could have additional notes added during tenant provisioning. | [optional] +**date_created** | **datetime** | Date when the product was created | [optional] +**last_updated** | **datetime** | Date when the product was last updated | [optional] +**org_type** | **Enum** [ 'development', 'staging', 'production', 'test', 'partner', 'training', 'demonstration', 'sandbox' ] | Type of org | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.product import Product + +product = Product( +product_name='idn', +url='https://tenant-name.identitynow.com', +product_tenant_id='tenant#product', +product_region='us-east-1', +product_right='idn:ui:view', +api_url='https://tenant-name.api.identitynow.com', +licenses=[ + sailpoint.v2024.models.license.License( + license_id = 'idn:access-request', + legacy_feature_name = 'ACCESS_REQUEST', ) + ], +attributes={domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250}, +zone='Deployment zone for the Product', +status='active', +status_date_time='2020-05-19T13:49:37.385Z', +reason='Reason', +notes='Example notes', +date_created='2020-05-19T13:49:37.385Z', +last_updated='2020-05-19T13:49:37.385Z', +org_type='test' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompleted.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..0c33a1b73 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompleted.md @@ -0,0 +1,74 @@ +--- +id: v2024-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompleted', 'V2024ProvisioningCompleted'] +slug: /tools/sdk/python/v2024/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'V2024ProvisioningCompleted'] +--- + +# ProvisioningCompleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tracking_number** | **str** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**sources** | **str** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**action** | **str** | Origin of where the provisioning request came from. | [optional] +**errors** | **[]str** | A list of any accumulated error messages that occurred during provisioning. | [optional] +**warnings** | **[]str** | A list of any accumulated warning messages that occurred during provisioning. | [optional] +**recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_completed import ProvisioningCompleted + +provisioning_completed = ProvisioningCompleted( +tracking_number='4b4d982dddff4267ab12f0f1e72b5a6d', +sources='Corp AD, Corp LDAP, Corp Salesforce', +action='IdentityRefresh', +errors=[ + 'Connector AD Failed' + ], +warnings=[ + 'Notification Skipped due to invalid email' + ], +recipient=sailpoint.v2024.models.provisioning_completed_recipient.ProvisioningCompleted_recipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +requester=sailpoint.v2024.models.provisioning_completed_requester.ProvisioningCompleted_requester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +account_requests=[ + sailpoint.v2024.models.provisioning_completed_account_requests_inner.ProvisioningCompleted_accountRequests_inner( + source = sailpoint.v2024.models.provisioning_completed_account_requests_inner_source.ProvisioningCompleted_accountRequests_inner_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), + account_id = 'CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com', + account_operation = 'Modify', + provisioning_result = SUCCESS, + provisioning_target = 'Corp AD', + ticket_id = '72619262', + attribute_requests = [ + sailpoint.v2024.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner( + attribute_name = 'memberOf', + attribute_value = 'CN=jedi,DC=starwars,DC=com', + operation = Add, ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..d5bf61e87 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,53 @@ +--- +id: v2024-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/python/v2024/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required] +**account_id** | **str** | The unique idenfier of the account being provisioned. | [optional] +**account_operation** | **str** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required] +**provisioning_result** | **Enum** [ 'SUCCESS', 'PENDING', 'FAILED' ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required] +**provisioning_target** | **str** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required] +**ticket_id** | **str** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] +**attribute_requests** | [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_completed_account_requests_inner import ProvisioningCompletedAccountRequestsInner + +provisioning_completed_account_requests_inner = ProvisioningCompletedAccountRequestsInner( +source=sailpoint.v2024.models.provisioning_completed_account_requests_inner_source.ProvisioningCompleted_accountRequests_inner_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), +account_id='CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com', +account_operation='Modify', +provisioning_result=SUCCESS, +provisioning_target='Corp AD', +ticket_id='72619262', +attribute_requests=[ + sailpoint.v2024.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner( + attribute_name = 'memberOf', + attribute_value = 'CN=jedi,DC=starwars,DC=com', + operation = Add, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..1a0867eab --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/python/v2024/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_name** | **str** | The name of the attribute being provisioned. | [required] +**attribute_value** | **str** | The value of the attribute being provisioned. | [optional] +**operation** | **Enum** [ 'Add', 'Set', 'Remove' ] | The operation to handle the attribute. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_completed_account_requests_inner_attribute_requests_inner import ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +provisioning_completed_account_requests_inner_attribute_requests_inner = ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner( +attribute_name='memberOf', +attribute_value='CN=jedi,DC=starwars,DC=com', +operation=Add +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..e1d1c7fba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2024ProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/python/v2024/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2024ProvisioningCompletedAccountRequestsInnerSource'] +--- + +# ProvisioningCompletedAccountRequestsInnerSource + +Reference to the source being provisioned against. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the object to which this reference applies | [required] +**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required] +**name** | **str** | Human-readable display name of the object to which this reference applies | [required] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_completed_account_requests_inner_source import ProvisioningCompletedAccountRequestsInnerSource + +provisioning_completed_account_requests_inner_source = ProvisioningCompletedAccountRequestsInnerSource( +id='4e4d982dddff4267ab12f0f1e72b5a6d', +type='SOURCE', +name='Corporate Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..d5b12522f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,38 @@ +--- +id: v2024-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedRecipient', 'V2024ProvisioningCompletedRecipient'] +slug: /tools/sdk/python/v2024/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'V2024ProvisioningCompletedRecipient'] +--- + +# ProvisioningCompletedRecipient + +Provisioning recpient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Provisioning recipient DTO type. | [required] +**id** | **str** | Provisioning recipient's identity ID. | [required] +**name** | **str** | Provisioning recipient's display name. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_completed_recipient import ProvisioningCompletedRecipient + +provisioning_completed_recipient = ProvisioningCompletedRecipient( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..e8222ffc5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,38 @@ +--- +id: v2024-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCompletedRequester', 'V2024ProvisioningCompletedRequester'] +slug: /tools/sdk/python/v2024/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'V2024ProvisioningCompletedRequester'] +--- + +# ProvisioningCompletedRequester + +Provisioning requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Provisioning requester's DTO type. | [required] +**id** | **str** | Provisioning requester's identity ID. | [required] +**name** | **str** | Provisioning owner's human-readable display name. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_completed_requester import ProvisioningCompletedRequester + +provisioning_completed_requester = ProvisioningCompletedRequester( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningConfig.md new file mode 100644 index 000000000..9d5cd74de --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningConfig.md @@ -0,0 +1,44 @@ +--- +id: v2024-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfig', 'V2024ProvisioningConfig'] +slug: /tools/sdk/python/v2024/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'V2024ProvisioningConfig'] +--- + +# ProvisioningConfig + +Specification of a Service Desk integration provisioning configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universal_manager** | **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to False] +**managed_resource_refs** | [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**plan_initializer_script** | [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**no_provisioning_requests** | **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to False] +**provisioning_request_expiration** | **int** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_config import ProvisioningConfig + +provisioning_config = ProvisioningConfig( +universal_manager=True, +managed_resource_refs=[{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], +plan_initializer_script=sailpoint.v2024.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), +no_provisioning_requests=True, +provisioning_request_expiration=7 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..02c731e4a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,35 @@ +--- +id: v2024-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'V2024ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/python/v2024/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'V2024ProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +This is a reference to a plan initializer script. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **str** | This is a Rule that allows provisioning instruction changes. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_config_plan_initializer_script import ProvisioningConfigPlanInitializerScript + +provisioning_config_plan_initializer_script = ProvisioningConfigPlanInitializerScript( +source='\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..68e315e61 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,45 @@ +--- +id: v2024-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel1', 'V2024ProvisioningCriteriaLevel1'] +slug: /tools/sdk/python/v2024/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024ProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_criteria_level1 import ProvisioningCriteriaLevel1 + +provisioning_criteria_level1 = ProvisioningCriteriaLevel1( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v2024.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..dddd29dcb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,45 @@ +--- +id: v2024-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel2', 'V2024ProvisioningCriteriaLevel2'] +slug: /tools/sdk/python/v2024/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024ProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_criteria_level2 import ProvisioningCriteriaLevel2 + +provisioning_criteria_level2 = ProvisioningCriteriaLevel2( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v2024.models.provisioning_criteria_level3.ProvisioningCriteriaLevel3( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..ca7e512ea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,40 @@ +--- +id: v2024-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel3', 'V2024ProvisioningCriteriaLevel3'] +slug: /tools/sdk/python/v2024/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024ProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_criteria_level3 import ProvisioningCriteriaLevel3 + +provisioning_criteria_level3 = ProvisioningCriteriaLevel3( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..108d3432e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: v2024-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaOperation', 'V2024ProvisioningCriteriaOperation'] +slug: /tools/sdk/python/v2024/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V2024ProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +Supported operations on ProvisioningCriteria + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `HAS` (value: `'HAS'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningDetails.md new file mode 100644 index 000000000..d3aabcce0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningDetails.md @@ -0,0 +1,34 @@ +--- +id: v2024-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningDetails', 'V2024ProvisioningDetails'] +slug: /tools/sdk/python/v2024/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'V2024ProvisioningDetails'] +--- + +# ProvisioningDetails + +Provides additional details about provisioning for this request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ordered_sub_phase_references** | **str** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_details import ProvisioningDetails + +provisioning_details = ProvisioningDetails( +ordered_sub_phase_references='manualWorkItemDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningPolicy.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..f468e1ecf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningPolicy.md @@ -0,0 +1,47 @@ +--- +id: v2024-provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningPolicy', 'V2024ProvisioningPolicy'] +slug: /tools/sdk/python/v2024/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'V2024ProvisioningPolicy'] +--- + +# ProvisioningPolicy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the provisioning policy name | [required] +**description** | **str** | the description of the provisioning policy | [optional] +**usage_type** | [**UsageType**](usage-type) | | [optional] +**fields** | [**[]FieldDetailsDto**](field-details-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_policy import ProvisioningPolicy + +provisioning_policy = ProvisioningPolicy( +name='example provisioning policy for inactive identities', +description='this provisioning policy creates access based on an identity going inactive', +usage_type='CREATE', +fields=[ + sailpoint.v2024.models.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/ProvisioningPolicyDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..a484a80db --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningPolicyDto.md @@ -0,0 +1,47 @@ +--- +id: v2024-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningPolicyDto', 'V2024ProvisioningPolicyDto'] +slug: /tools/sdk/python/v2024/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'V2024ProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the provisioning policy name | [required] +**description** | **str** | the description of the provisioning policy | [optional] +**usage_type** | [**UsageType**](usage-type) | | [optional] +**fields** | [**[]FieldDetailsDto**](field-details-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto + +provisioning_policy_dto = ProvisioningPolicyDto( +name='example provisioning policy for inactive identities', +description='this provisioning policy creates access based on an identity going inactive', +usage_type='CREATE', +fields=[ + sailpoint.v2024.models.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/ProvisioningState.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningState.md new file mode 100644 index 000000000..286dd9fc6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningState.md @@ -0,0 +1,31 @@ +--- +id: v2024-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningState', 'V2024ProvisioningState'] +slug: /tools/sdk/python/v2024/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'V2024ProvisioningState'] +--- + +# ProvisioningState + +Provisioning state of an account activity item + +## Enum + +* `PENDING` (value: `'PENDING'`) + +* `FINISHED` (value: `'FINISHED'`) + +* `UNVERIFIABLE` (value: `'UNVERIFIABLE'`) + +* `COMMITED` (value: `'COMMITED'`) + +* `FAILED` (value: `'FAILED'`) + +* `RETRY` (value: `'RETRY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentity.md new file mode 100644 index 000000000..9dafeddeb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentity.md @@ -0,0 +1,56 @@ +--- +id: v2024-public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentity', 'V2024PublicIdentity'] +slug: /tools/sdk/python/v2024/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'V2024PublicIdentity'] +--- + +# PublicIdentity + +Details about a public identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +**alias** | **str** | Alternate unique identifier for the identity. | [optional] +**email** | **str** | Email address of identity. | [optional] +**status** | **str** | The lifecycle status for the identity | [optional] +**identity_state** | **Enum** [ 'ACTIVE', 'INACTIVE_SHORT_TERM', 'INACTIVE_LONG_TERM' ] | 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. | [optional] +**manager** | [**IdentityReference**](identity-reference) | | [optional] +**attributes** | [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.public_identity import PublicIdentity + +public_identity = PublicIdentity( +id='2c9180857182305e0171993735622948', +name='Alison Ferguso', +alias='alison.ferguso', +email='alison.ferguso@acme-solar.com', +status='Active', +identity_state='ACTIVE', +manager=sailpoint.v2024.models.identity_reference.IdentityReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ), +attributes=[ + sailpoint.v2024.models.public_identity_attributes_inner.PublicIdentity_attributes_inner( + key = 'country', + name = 'Country', + value = 'US', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..67e3d6b3b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,36 @@ +--- +id: v2024-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityAttributeConfig', 'V2024PublicIdentityAttributeConfig'] +slug: /tools/sdk/python/v2024/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'V2024PublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +Used to map an attribute key for an Identity to its display name. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The attribute key | [optional] +**name** | **str** | The attribute display name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.public_identity_attribute_config import PublicIdentityAttributeConfig + +public_identity_attribute_config = PublicIdentityAttributeConfig( +key='country', +name='Country' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..9563eddf3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityAttributesInner', 'V2024PublicIdentityAttributesInner'] +slug: /tools/sdk/python/v2024/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'V2024PublicIdentityAttributesInner'] +--- + +# PublicIdentityAttributesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The attribute key | [optional] +**name** | **str** | Human-readable display name of the attribute | [optional] +**value** | **str** | The attribute value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.public_identity_attributes_inner import PublicIdentityAttributesInner + +public_identity_attributes_inner = PublicIdentityAttributesInner( +key='country', +name='Country', +value='US' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..5ca766489 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PublicIdentityConfig.md @@ -0,0 +1,45 @@ +--- +id: v2024-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityConfig', 'V2024PublicIdentityConfig'] +slug: /tools/sdk/python/v2024/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'V2024PublicIdentityConfig'] +--- + +# PublicIdentityConfig + +Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**modified** | **datetime** | When this configuration was last modified. | [optional] +**modified_by** | [**IdentityReference**](identity-reference) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig + +public_identity_config = PublicIdentityConfig( +attributes=[ + sailpoint.v2024.models.public_identity_attribute_config.PublicIdentityAttributeConfig( + key = 'country', + name = 'Country', ) + ], +modified='2018-06-25T20:22:28.104Z', +modified_by=sailpoint.v2024.models.identity_reference.IdentityReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..61ebb5aaf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutClientLogConfigurationRequest', 'V2024PutClientLogConfigurationRequest'] +slug: /tools/sdk/python/v2024/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'V2024PutClientLogConfigurationRequest'] +--- + +# PutClientLogConfigurationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**expiration** | **datetime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + +put_client_log_configuration_request = PutClientLogConfigurationRequest( +client_id='3a38a51992e8445ab51a549c0a70ee66', +duration_minutes=120, +root_level='INFO', +log_levels=INFO, +expiration='2024-11-06T01:31:08.013164Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorCorrelationConfigRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorCorrelationConfigRequest.md new file mode 100644 index 000000000..05187c7b3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorCorrelationConfigRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-put-connector-correlation-config-request +title: PutConnectorCorrelationConfigRequest +pagination_label: PutConnectorCorrelationConfigRequest +sidebar_label: PutConnectorCorrelationConfigRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutConnectorCorrelationConfigRequest', 'V2024PutConnectorCorrelationConfigRequest'] +slug: /tools/sdk/python/v2024/models/put-connector-correlation-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorCorrelationConfigRequest', 'V2024PutConnectorCorrelationConfigRequest'] +--- + +# PutConnectorCorrelationConfigRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | connector correlation config xml file | [required] +} + +## Example + +```python +from sailpoint.v2024.models.put_connector_correlation_config_request import PutConnectorCorrelationConfigRequest + +put_connector_correlation_config_request = PutConnectorCorrelationConfigRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..6f5029984 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutConnectorSourceConfigRequest', 'V2024PutConnectorSourceConfigRequest'] +slug: /tools/sdk/python/v2024/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'V2024PutConnectorSourceConfigRequest'] +--- + +# PutConnectorSourceConfigRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | connector source config xml file | [required] +} + +## Example + +```python +from sailpoint.v2024.models.put_connector_source_config_request import PutConnectorSourceConfigRequest + +put_connector_source_config_request = PutConnectorSourceConfigRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..f887bb775 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutConnectorSourceTemplateRequest', 'V2024PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/python/v2024/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'V2024PutConnectorSourceTemplateRequest'] +--- + +# PutConnectorSourceTemplateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | connector source template xml file | [required] +} + +## Example + +```python +from sailpoint.v2024.models.put_connector_source_template_request import PutConnectorSourceTemplateRequest + +put_connector_source_template_request = PutConnectorSourceTemplateRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..b0911c310 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutPasswordDictionaryRequest', 'V2024PutPasswordDictionaryRequest'] +slug: /tools/sdk/python/v2024/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'V2024PutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.put_password_dictionary_request import PutPasswordDictionaryRequest + +put_password_dictionary_request = PutPasswordDictionaryRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Query.md b/docs/tools/sdk/python/Reference/V2024/Models/Query.md new file mode 100644 index 000000000..0426164a7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Query.md @@ -0,0 +1,42 @@ +--- +id: v2024-query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Query', 'V2024Query'] +slug: /tools/sdk/python/v2024/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'V2024Query'] +--- + +# Query + +Query parameters used to construct an Elasticsearch query object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | 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. | [optional] +**fields** | **str** | 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. | [optional] +**time_zone** | **str** | The time zone to be applied to any range query related to dates. | [optional] +**inner_hit** | [**InnerHit**](inner-hit) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.query import Query + +query = Query( +query='name:a*', +fields='[firstName,lastName,email]', +time_zone='America/Chicago', +inner_hit=sailpoint.v2024.models.inner_hit.InnerHit( + query = 'source.name:\"Active Directory\"', + type = 'access', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/QueryResultFilter.md b/docs/tools/sdk/python/Reference/V2024/Models/QueryResultFilter.md new file mode 100644 index 000000000..402895827 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/QueryResultFilter.md @@ -0,0 +1,36 @@ +--- +id: v2024-query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueryResultFilter', 'V2024QueryResultFilter'] +slug: /tools/sdk/python/v2024/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'V2024QueryResultFilter'] +--- + +# QueryResultFilter + +Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includes** | **[]str** | The list of field names to include in the result documents. | [optional] +**excludes** | **[]str** | The list of field names to exclude from the result documents. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.query_result_filter import QueryResultFilter + +query_result_filter = QueryResultFilter( +includes=[name, displayName], +excludes=[stacktrace] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/QueryType.md b/docs/tools/sdk/python/Reference/V2024/Models/QueryType.md new file mode 100644 index 000000000..9bc14d2f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/QueryType.md @@ -0,0 +1,27 @@ +--- +id: v2024-query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueryType', 'V2024QueryType'] +slug: /tools/sdk/python/v2024/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'V2024QueryType'] +--- + +# QueryType + +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. + +## Enum + +* `DSL` (value: `'DSL'`) + +* `SAILPOINT` (value: `'SAILPOINT'`) + +* `TEXT` (value: `'TEXT'`) + +* `TYPEAHEAD` (value: `'TYPEAHEAD'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..26dfdc37a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,36 @@ +--- +id: v2024-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueuedCheckConfigDetails', 'V2024QueuedCheckConfigDetails'] +slug: /tools/sdk/python/v2024/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'V2024QueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +Configuration of maximum number of days and interval for checking Service Desk integration queue status. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provisioning_status_check_interval_minutes** | **str** | Interval in minutes between status checks | [required] +**provisioning_max_status_check_days** | **str** | Maximum number of days to check | [required] +} + +## Example + +```python +from sailpoint.v2024.models.queued_check_config_details import QueuedCheckConfigDetails + +queued_check_config_details = QueuedCheckConfigDetails( +provisioning_status_check_interval_minutes='30', +provisioning_max_status_check_days='2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Range.md b/docs/tools/sdk/python/Reference/V2024/Models/Range.md new file mode 100644 index 000000000..09c987244 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Range.md @@ -0,0 +1,40 @@ +--- +id: v2024-range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Range', 'V2024Range'] +slug: /tools/sdk/python/v2024/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'V2024Range'] +--- + +# Range + +The range of values to be filtered. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lower** | [**Bound**](bound) | | [optional] +**upper** | [**Bound**](bound) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.range import Range + +range = Range( +lower=sailpoint.v2024.models.bound.Bound( + value = '1', + inclusive = False, ), +upper=sailpoint.v2024.models.bound.Bound( + value = '1', + inclusive = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReassignReference.md b/docs/tools/sdk/python/Reference/V2024/Models/ReassignReference.md new file mode 100644 index 000000000..2042c083a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReassignReference.md @@ -0,0 +1,35 @@ +--- +id: v2024-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignReference', 'V2024ReassignReference'] +slug: /tools/sdk/python/v2024/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'V2024ReassignReference'] +--- + +# ReassignReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of item or identity being reassigned. | [required] +**type** | **Enum** [ 'TARGET_SUMMARY', 'ITEM', 'IDENTITY_SUMMARY' ] | The type of item or identity being reassigned. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.reassign_reference import ReassignReference + +reassign_reference = ReassignReference( +id='ef38f94347e94562b5bb8424a56397d8', +type='ITEM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Reassignment.md b/docs/tools/sdk/python/Reference/V2024/Models/Reassignment.md new file mode 100644 index 000000000..94cf958e5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Reassignment.md @@ -0,0 +1,45 @@ +--- +id: v2024-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reassignment', 'V2024Reassignment'] +slug: /tools/sdk/python/v2024/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'V2024Reassignment'] +--- + +# Reassignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_from** | [**CertificationReference**](certification-reference) | | [optional] +**comment** | **str** | The comment entered when the Certification was reassigned | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reassignment import Reassignment + +reassignment = Reassignment( +var_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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentReference.md b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentReference.md new file mode 100644 index 000000000..09cf59f80 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentReference.md @@ -0,0 +1,35 @@ +--- +id: v2024-reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentReference', 'V2024ReassignmentReference'] +slug: /tools/sdk/python/v2024/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'V2024ReassignmentReference'] +--- + +# ReassignmentReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of item or identity being reassigned. | [required] +**type** | **Enum** [ 'TARGET_SUMMARY', 'ITEM', 'IDENTITY_SUMMARY' ] | The type of item or identity being reassigned. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.reassignment_reference import ReassignmentReference + +reassignment_reference = ReassignmentReference( +id='ef38f94347e94562b5bb8424a56397d8', +type='ITEM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..8b076f26e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentTrailDTO.md @@ -0,0 +1,37 @@ +--- +id: v2024-reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentTrailDTO', 'V2024ReassignmentTrailDTO'] +slug: /tools/sdk/python/v2024/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'V2024ReassignmentTrailDTO'] +--- + +# ReassignmentTrailDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous_owner** | **str** | The ID of previous owner identity. | [optional] +**new_owner** | **str** | The ID of new owner identity. | [optional] +**reassignment_type** | **str** | The type of reassignment. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reassignment_trail_dto import ReassignmentTrailDTO + +reassignment_trail_dto = ReassignmentTrailDTO( +previous_owner='ef38f94347e94562b5bb8424a56397d8', +new_owner='ef38f94347e94562b5bb8424a56397a3', +reassignment_type='AUTOMATIC_REASSIGNMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentType.md b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentType.md new file mode 100644 index 000000000..222415258 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentType.md @@ -0,0 +1,27 @@ +--- +id: v2024-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentType', 'V2024ReassignmentType'] +slug: /tools/sdk/python/v2024/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'V2024ReassignmentType'] +--- + +# ReassignmentType + +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). + +## Enum + +* `MANUAL_REASSIGNMENT` (value: `'MANUAL_REASSIGNMENT'`) + +* `AUTOMATIC_REASSIGNMENT` (value: `'AUTOMATIC_REASSIGNMENT'`) + +* `AUTO_ESCALATION` (value: `'AUTO_ESCALATION'`) + +* `SELF_REVIEW_DELEGATION` (value: `'SELF_REVIEW_DELEGATION'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..32ba3f803 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReassignmentTypeEnum.md @@ -0,0 +1,27 @@ +--- +id: v2024-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentTypeEnum', 'V2024ReassignmentTypeEnum'] +slug: /tools/sdk/python/v2024/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'V2024ReassignmentTypeEnum'] +--- + +# ReassignmentTypeEnum + +Enum list containing types of Reassignment that can be found in the evaluate response. + +## Enum + +* `MANUAL_REASSIGNMENT_COMMA` (value: `'MANUAL_REASSIGNMENT,'`) + +* `AUTOMATIC_REASSIGNMENT_COMMA` (value: `'AUTOMATIC_REASSIGNMENT,'`) + +* `AUTO_ESCALATION_COMMA` (value: `'AUTO_ESCALATION,'`) + +* `SELF_REVIEW_DELEGATION` (value: `'SELF_REVIEW_DELEGATION'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Recommendation.md b/docs/tools/sdk/python/Reference/V2024/Models/Recommendation.md new file mode 100644 index 000000000..3a5d842a2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Recommendation.md @@ -0,0 +1,35 @@ +--- +id: v2024-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Recommendation', 'V2024Recommendation'] +slug: /tools/sdk/python/v2024/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'V2024Recommendation'] +--- + +# Recommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required] +**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.recommendation import Recommendation + +recommendation = Recommendation( +type='MACHINE', +method='DISCOVERY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommendationConfigDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..4b94ae68e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationConfigDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationConfigDto', 'V2024RecommendationConfigDto'] +slug: /tools/sdk/python/v2024/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'V2024RecommendationConfigDto'] +--- + +# RecommendationConfigDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommender_features** | **[]str** | List of identity attributes to use for calculating certification recommendations | [optional] +**peer_group_percentage_threshold** | **float** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**run_auto_select_once** | **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to False] +**only_tune_threshold** | **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfigDto + +recommendation_config_dto = RecommendationConfigDto( +recommender_features=[jobTitle, location, peer_group, department, active], +peer_group_percentage_threshold=0.5, +run_auto_select_once=False, +only_tune_threshold=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommendationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationRequest.md new file mode 100644 index 000000000..c5a00f3d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationRequest', 'V2024RecommendationRequest'] +slug: /tools/sdk/python/v2024/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'V2024RecommendationRequest'] +--- + +# RecommendationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID | [optional] +**item** | [**AccessItemRef**](access-item-ref) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.recommendation_request import RecommendationRequest + +recommendation_request = RecommendationRequest( +identity_id='2c938083633d259901633d25c68c00fa', +item=sailpoint.v2024.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommendationRequestDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..252802811 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationRequestDto.md @@ -0,0 +1,47 @@ +--- +id: v2024-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationRequestDto', 'V2024RecommendationRequestDto'] +slug: /tools/sdk/python/v2024/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'V2024RecommendationRequestDto'] +--- + +# RecommendationRequestDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requests** | [**[]RecommendationRequest**](recommendation-request) | | [optional] +**exclude_interpretations** | **bool** | Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. | [optional] [default to False] +**include_translation_messages** | **bool** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to False] +**include_debug_information** | **bool** | Returns the recommender calculations if set to true | [optional] [default to False] +**prescribe_mode** | **bool** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.recommendation_request_dto import RecommendationRequestDto + +recommendation_request_dto = RecommendationRequestDto( +requests=[ + sailpoint.v2024.models.recommendation_request.RecommendationRequest( + identity_id = '2c938083633d259901633d25c68c00fa', + item = sailpoint.v2024.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ), ) + ], +exclude_interpretations=False, +include_translation_messages=False, +include_debug_information=True, +prescribe_mode=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommendationResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationResponse.md new file mode 100644 index 000000000..8ef5763c7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationResponse.md @@ -0,0 +1,61 @@ +--- +id: v2024-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationResponse', 'V2024RecommendationResponse'] +slug: /tools/sdk/python/v2024/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'V2024RecommendationResponse'] +--- + +# RecommendationResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request** | [**RecommendationRequest**](recommendation-request) | | [optional] +**recommendation** | **Enum** [ 'true', 'false', 'MAYBE', 'NOT_FOUND' ] | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**interpretations** | **[]str** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**translation_messages** | [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**recommender_calculations** | [**RecommenderCalculations**](recommender-calculations) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.recommendation_response import RecommendationResponse + +recommendation_response = RecommendationResponse( +request=sailpoint.v2024.models.recommendation_request.RecommendationRequest( + identity_id = '2c938083633d259901633d25c68c00fa', + item = sailpoint.v2024.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ), ), +recommendation='true', +interpretations=[75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.], +translation_messages=[{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}], +recommender_calculations=sailpoint.v2024.models.recommender_calculations.RecommenderCalculations( + identity_id = '2c91808457d8f3ab0157e3e62cb4213c', + entitlement_id = '2c91809050db617d0150e0bf3215385e', + recommendation = 'YES', + overall_weighted_score = 1.337, + feature_weighted_scores = { + 'key' : 1.337 + }, + threshold = 1.337, + identity_attributes = { + 'key' : sailpoint.v2024.models.recommender_calculations_identity_attributes_value.RecommenderCalculations_identityAttributes_value( + value = '', ) + }, + feature_values = sailpoint.v2024.models.feature_value_dto.FeatureValueDto( + feature = 'department', + numerator = 14, + denominator = 14, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommendationResponseDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..005d2f226 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommendationResponseDto.md @@ -0,0 +1,60 @@ +--- +id: v2024-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommendationResponseDto', 'V2024RecommendationResponseDto'] +slug: /tools/sdk/python/v2024/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'V2024RecommendationResponseDto'] +--- + +# RecommendationResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**response** | [**[]RecommendationResponse**](recommendation-response) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.recommendation_response_dto import RecommendationResponseDto + +recommendation_response_dto = RecommendationResponseDto( +response=[ + sailpoint.v2024.models.recommendation_response.RecommendationResponse( + request = sailpoint.v2024.models.recommendation_request.RecommendationRequest( + identity_id = '2c938083633d259901633d25c68c00fa', + item = sailpoint.v2024.models.access_item_ref.AccessItemRef( + id = '2c938083633d259901633d2623ec0375', + type = 'ENTITLEMENT', ), ), + recommendation = 'true', + interpretations = [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.], + translation_messages = [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}], + recommender_calculations = sailpoint.v2024.models.recommender_calculations.RecommenderCalculations( + identity_id = '2c91808457d8f3ab0157e3e62cb4213c', + entitlement_id = '2c91809050db617d0150e0bf3215385e', + recommendation = 'YES', + overall_weighted_score = 1.337, + feature_weighted_scores = { + 'key' : 1.337 + }, + threshold = 1.337, + identity_attributes = { + 'key' : sailpoint.v2024.models.recommender_calculations_identity_attributes_value.RecommenderCalculations_identityAttributes_value( + value = '', ) + }, + feature_values = sailpoint.v2024.models.feature_value_dto.FeatureValueDto( + feature = 'department', + numerator = 14, + denominator = 14, ), ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommenderCalculations.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommenderCalculations.md new file mode 100644 index 000000000..3d2a79e21 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommenderCalculations.md @@ -0,0 +1,55 @@ +--- +id: v2024-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommenderCalculations', 'V2024RecommenderCalculations'] +slug: /tools/sdk/python/v2024/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'V2024RecommenderCalculations'] +--- + +# RecommenderCalculations + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The ID of the identity | [optional] +**entitlement_id** | **str** | The entitlement ID | [optional] +**recommendation** | **str** | The actual recommendation | [optional] +**overall_weighted_score** | **float** | The overall weighted score | [optional] +**feature_weighted_scores** | **map[string]float** | The weighted score of each individual feature | [optional] +**threshold** | **float** | The configured value against which the overallWeightedScore is compared | [optional] +**identity_attributes** | [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**feature_values** | [**FeatureValueDto**](feature-value-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.recommender_calculations import RecommenderCalculations + +recommender_calculations = RecommenderCalculations( +identity_id='2c91808457d8f3ab0157e3e62cb4213c', +entitlement_id='2c91809050db617d0150e0bf3215385e', +recommendation='YES', +overall_weighted_score=1.337, +feature_weighted_scores={ + 'key' : 1.337 + }, +threshold=1.337, +identity_attributes={ + 'key' : sailpoint.v2024.models.recommender_calculations_identity_attributes_value.RecommenderCalculations_identityAttributes_value( + value = '', ) + }, +feature_values=sailpoint.v2024.models.feature_value_dto.FeatureValueDto( + feature = 'department', + numerator = 14, + denominator = 14, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/python/Reference/V2024/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..3bd9287fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,33 @@ +--- +id: v2024-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'V2024RecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/python/v2024/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'V2024RecommenderCalculationsIdentityAttributesValue'] +--- + +# RecommenderCalculationsIdentityAttributesValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.recommender_calculations_identity_attributes_value import RecommenderCalculationsIdentityAttributesValue + +recommender_calculations_identity_attributes_value = RecommenderCalculationsIdentityAttributesValue( +value='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Ref.md b/docs/tools/sdk/python/Reference/V2024/Models/Ref.md new file mode 100644 index 000000000..03c2f4da6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Ref.md @@ -0,0 +1,35 @@ +--- +id: v2024-ref +title: Ref +pagination_label: Ref +sidebar_label: Ref +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Ref', 'V2024Ref'] +slug: /tools/sdk/python/v2024/models/ref +tags: ['SDK', 'Software Development Kit', 'Ref', 'V2024Ref'] +--- + +# Ref + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.ref import Ref + +ref = Ref( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Reference.md b/docs/tools/sdk/python/Reference/V2024/Models/Reference.md new file mode 100644 index 000000000..a06452db1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Reference.md @@ -0,0 +1,35 @@ +--- +id: v2024-reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reference', 'V2024Reference'] +slug: /tools/sdk/python/v2024/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'V2024Reference'] +--- + +# Reference + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.reference import Reference + +reference = Reference( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RemediationItemDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/RemediationItemDetails.md new file mode 100644 index 000000000..9564e0076 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RemediationItemDetails.md @@ -0,0 +1,49 @@ +--- +id: v2024-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RemediationItemDetails', 'V2024RemediationItemDetails'] +slug: /tools/sdk/python/v2024/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'V2024RemediationItemDetails'] +--- + +# RemediationItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification | [optional] +**target_id** | **str** | The ID of the certification target | [optional] +**target_name** | **str** | The name of the certification target | [optional] +**target_display_name** | **str** | The display name of the certification target | [optional] +**application_name** | **str** | The name of the application/source | [optional] +**attribute_name** | **str** | The name of the attribute being certified | [optional] +**attribute_operation** | **str** | The operation of the certification on the attribute | [optional] +**attribute_value** | **str** | The value of the attribute being certified | [optional] +**native_identity** | **str** | The native identity of the target | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.remediation_item_details import RemediationItemDetails + +remediation_item_details = RemediationItemDetails( +id='2c9180835d2e5168015d32f890ca1581', +target_id='2c9180835d2e5168015d32f890ca1581', +target_name='john.smith', +target_display_name='emailAddress', +application_name='Active Directory', +attribute_name='phoneNumber', +attribute_operation='update', +attribute_value='512-555-1212', +native_identity='jason.smith2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RemediationItems.md b/docs/tools/sdk/python/Reference/V2024/Models/RemediationItems.md new file mode 100644 index 000000000..92e46813b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RemediationItems.md @@ -0,0 +1,49 @@ +--- +id: v2024-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RemediationItems', 'V2024RemediationItems'] +slug: /tools/sdk/python/v2024/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'V2024RemediationItems'] +--- + +# RemediationItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification | [optional] +**target_id** | **str** | The ID of the certification target | [optional] +**target_name** | **str** | The name of the certification target | [optional] +**target_display_name** | **str** | The display name of the certification target | [optional] +**application_name** | **str** | The name of the application/source | [optional] +**attribute_name** | **str** | The name of the attribute being certified | [optional] +**attribute_operation** | **str** | The operation of the certification on the attribute | [optional] +**attribute_value** | **str** | The value of the attribute being certified | [optional] +**native_identity** | **str** | The native identity of the target | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.remediation_items import RemediationItems + +remediation_items = RemediationItems( +id='2c9180835d2e5168015d32f890ca1581', +target_id='2c9180835d2e5168015d32f890ca1581', +target_name='john.smith', +target_display_name='emailAddress', +application_name='Active Directory', +attribute_name='phoneNumber', +attribute_operation='update', +attribute_value='512-555-1212', +native_identity='jason.smith2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReportConfigDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/ReportConfigDTO.md new file mode 100644 index 000000000..27aed95ba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReportConfigDTO.md @@ -0,0 +1,39 @@ +--- +id: v2024-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportConfigDTO', 'V2024ReportConfigDTO'] +slug: /tools/sdk/python/v2024/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'V2024ReportConfigDTO'] +--- + +# ReportConfigDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**column_name** | **str** | Name of column in report | [optional] +**required** | **bool** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to False] +**included** | **bool** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to False] +**order** | **int** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.report_config_dto import ReportConfigDTO + +report_config_dto = ReportConfigDTO( +column_name='SOD Business Name', +required=True, +included=False, +order=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReportDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/ReportDetails.md new file mode 100644 index 000000000..44bbae7ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReportDetails.md @@ -0,0 +1,36 @@ +--- +id: v2024-report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportDetails', 'V2024ReportDetails'] +slug: /tools/sdk/python/v2024/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'V2024ReportDetails'] +--- + +# ReportDetails + +Details about report to be processed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional] +**arguments** | [**ReportDetailsArguments**](report-details-arguments) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.report_details import ReportDetails + +report_details = ReportDetails( +report_type='ACCOUNTS', +arguments={application=2c9180897e7742b2017e781782f705b9, sourceName=Active Directory} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReportDetailsArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..916624371 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReportDetailsArguments.md @@ -0,0 +1,50 @@ +--- +id: v2024-report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportDetailsArguments', 'V2024ReportDetailsArguments'] +slug: /tools/sdk/python/v2024/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'V2024ReportDetailsArguments'] +--- + +# ReportDetailsArguments + +The string-object map(dictionary) with the arguments needed for report processing. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | **str** | Source ID. | [required] +**source_name** | **str** | Source name. | [required] +**correlated_only** | **bool** | Flag to specify if only correlated identities are included in report. | [required][default to False] +**authoritative_source** | **str** | Source ID. | [required] +**selected_formats** | **[]str** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**query** | **str** | 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. | [required] +**columns** | **str** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.report_details_arguments import ReportDetailsArguments + +report_details_arguments = ReportDetailsArguments( +application='2c9180897eSourceIde781782f705b9', +source_name='Active Directory', +correlated_only=True, +authoritative_source='1234sourceId5678902', +selected_formats=[CSV], +indices=[entitlements], +query='name:a*', +columns='displayName,firstName,lastName,email,created,attributes.cloudLifecycleState', +sort=[displayName, +id] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReportResultReference.md b/docs/tools/sdk/python/Reference/V2024/Models/ReportResultReference.md new file mode 100644 index 000000000..07c0da202 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReportResultReference.md @@ -0,0 +1,39 @@ +--- +id: v2024-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportResultReference', 'V2024ReportResultReference'] +slug: /tools/sdk/python/v2024/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'V2024ReportResultReference'] +--- + +# ReportResultReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +**status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR', 'PENDING' ] | Status of a SOD policy violation report. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.report_result_reference import ReportResultReference + +report_result_reference = ReportResultReference( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation', +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReportResults.md b/docs/tools/sdk/python/Reference/V2024/Models/ReportResults.md new file mode 100644 index 000000000..65d94f4ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReportResults.md @@ -0,0 +1,48 @@ +--- +id: v2024-report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportResults', 'V2024ReportResults'] +slug: /tools/sdk/python/v2024/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'V2024ReportResults'] +--- + +# ReportResults + +Details about report result or current state. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional] +**task_def_name** | **str** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**id** | **str** | Unique task definition identifier. | [optional] +**created** | **datetime** | Report processing start date | [optional] +**status** | **Enum** [ 'SUCCESS', 'FAILURE', 'WARNING', 'TERMINATED' ] | Report current state or result status. | [optional] +**duration** | **int** | Report processing time in ms. | [optional] +**rows** | **int** | Report size in rows. | [optional] +**available_formats** | **[]str** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.report_results import ReportResults + +report_results = ReportResults( +report_type='IDENTITIES_DETAILS', +task_def_name='Identities Details Report', +id='a248c16fe22222b2bd49615481311111', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +status='SUCCESS', +duration=342, +rows=37, +available_formats=[CSV] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReportType.md b/docs/tools/sdk/python/Reference/V2024/Models/ReportType.md new file mode 100644 index 000000000..c58564251 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReportType.md @@ -0,0 +1,27 @@ +--- +id: v2024-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportType', 'V2024ReportType'] +slug: /tools/sdk/python/v2024/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'V2024ReportType'] +--- + +# ReportType + +type of a Report + +## Enum + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `'CAMPAIGN_COMPOSITION_REPORT'`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `'CAMPAIGN_REMEDIATION_STATUS_REPORT'`) + +* `CAMPAIGN_STATUS_REPORT` (value: `'CAMPAIGN_STATUS_REPORT'`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `'CERTIFICATION_SIGNOFF_REPORT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..c0c6743a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestOnBehalfOfConfig', 'V2024RequestOnBehalfOfConfig'] +slug: /tools/sdk/python/v2024/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'V2024RequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allow_request_on_behalf_of_anyone_by_anyone** | **bool** | If this is true, anyone can request access for anyone. | [optional] [default to False] +**allow_request_on_behalf_of_employee_by_manager** | **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.request_on_behalf_of_config import RequestOnBehalfOfConfig + +request_on_behalf_of_config = RequestOnBehalfOfConfig( +allow_request_on_behalf_of_anyone_by_anyone=True, +allow_request_on_behalf_of_employee_by_manager=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md b/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md new file mode 100644 index 000000000..13c2ed16a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md @@ -0,0 +1,41 @@ +--- +id: v2024-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Requestability', 'V2024Requestability'] +slug: /tools/sdk/python/v2024/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability'] +--- + +# Requestability + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requestability import Requestability + +requestability = Requestability( +comments_required=True, +denial_comments_required=True, +approval_schemes=[ + sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md new file mode 100644 index 000000000..1ab2dd8b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md @@ -0,0 +1,41 @@ +--- +id: v2024-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestabilityForRole', 'V2024RequestabilityForRole'] +slug: /tools/sdk/python/v2024/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'V2024RequestabilityForRole'] +--- + +# RequestabilityForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requestability_for_role import RequestabilityForRole + +requestability_for_role = RequestabilityForRole( +comments_required=True, +denial_comments_required=True, +approval_schemes=[ + sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestableObject.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObject.md new file mode 100644 index 000000000..2d723cfeb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObject.md @@ -0,0 +1,55 @@ +--- +id: v2024-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObject', 'V2024RequestableObject'] +slug: /tools/sdk/python/v2024/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'V2024RequestableObject'] +--- + +# RequestableObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the requestable object itself | [optional] +**name** | **str** | Human-readable display name of the requestable object | [optional] +**created** | **datetime** | The time when the requestable object was created | [optional] +**modified** | **datetime** | The time when the requestable object was last modified | [optional] +**description** | **str** | Description of the requestable object. | [optional] +**type** | [**RequestableObjectType**](requestable-object-type) | | [optional] +**request_status** | [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**identity_request_id** | **str** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**owner_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**request_comments_required** | **bool** | Whether the requester must provide comments when requesting the object. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requestable_object import RequestableObject + +requestable_object = RequestableObject( +id='2c9180835d2e5168015d32f890ca1581', +name='Applied Research Access', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +description='Access to research information, lab results, and schematics.', +type='ACCESS_PROFILE', +request_status=, +identity_request_id='', +owner_ref=sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +request_comments_required=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectReference.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectReference.md new file mode 100644 index 000000000..9371c3b30 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectReference.md @@ -0,0 +1,39 @@ +--- +id: v2024-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectReference', 'V2024RequestableObjectReference'] +slug: /tools/sdk/python/v2024/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'V2024RequestableObjectReference'] +--- + +# RequestableObjectReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the object. | [optional] +**name** | **str** | Name of the object. | [optional] +**description** | **str** | Description of the object. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of the object. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requestable_object_reference import RequestableObjectReference + +requestable_object_reference = RequestableObjectReference( +id='2c9180835d2e5168015d32f890ca1581', +name='Applied Research Access', +description='Access to research information, lab results, and schematics', +type='ROLE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..5997a7ac1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,25 @@ +--- +id: v2024-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectRequestStatus', 'V2024RequestableObjectRequestStatus'] +slug: /tools/sdk/python/v2024/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'V2024RequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. + +## Enum + +* `AVAILABLE` (value: `'AVAILABLE'`) + +* `PENDING` (value: `'PENDING'`) + +* `ASSIGNED` (value: `'ASSIGNED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectType.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectType.md new file mode 100644 index 000000000..0dc2bca97 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestableObjectType.md @@ -0,0 +1,25 @@ +--- +id: v2024-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectType', 'V2024RequestableObjectType'] +slug: /tools/sdk/python/v2024/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'V2024RequestableObjectType'] +--- + +# RequestableObjectType + +The currently supported requestable object types. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDetails.md new file mode 100644 index 000000000..227752181 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDetails', 'V2024RequestedItemDetails'] +slug: /tools/sdk/python/v2024/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'V2024RequestedItemDetails'] +--- + +# RequestedItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ENTITLEMENT', 'ROLE' ] | The type of access item requested. | [optional] +**id** | **str** | The id of the access item requested. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_details import RequestedItemDetails + +requested_item_details = RequestedItemDetails( +type='ENTITLEMENT', +id='779c6fd7171540bba1184e5946112c28' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatus.md new file mode 100644 index 000000000..8225b4b80 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatus.md @@ -0,0 +1,138 @@ +--- +id: v2024-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'V2024RequestedItemStatus'] +slug: /tools/sdk/python/v2024/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'V2024RequestedItemStatus'] +--- + +# RequestedItemStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. | [optional] +**name** | **str** | Human-readable display name of the item being requested. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional] +**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional] +**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**account_activity_item_id** | **str** | Id of associated account activity item. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**description** | **str** | Description associated to the requested object. | [optional] +**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional] +**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False] +**access_request_id** | **str** | This is the account activity id. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_status import RequestedItemStatus + +requested_item_status = RequestedItemStatus( +id='2c9180926cbfbddd016cbfc7c3b10010', +name='AccessProfile1', +type='ACCESS_PROFILE', +cancelled_request_details=, +error_messages=[ + {locale=en-US, localeOrigin=DEFAULT, text=Error Message} + ], +state='EXECUTING', +approval_details=[ + sailpoint.v2024.models.approval_status_dto.ApprovalStatusDto( + forwarded = False, + original_owner = sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = null, + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + scheme = 'MANAGER', + error_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.', ) + ], + comment = 'I approve this request', + remove_date = '2020-07-11T00:00Z', ) + ], +approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5], +manual_work_item_details=[ + sailpoint.v2024.models.manual_work_item_details.ManualWorkItemDetails( + forwarded = True, + original_owner = sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = sailpoint.v2024.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + forward_history = [ + sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], ) + ], +account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010', +request_type='GRANT_ACCESS', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +requester=sailpoint.v2024.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v2024.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +requester_comment=, +sod_violation_context=, +provisioning_details=, +pre_approval_trigger_details=, +access_request_phases=[ + sailpoint.v2024.models.access_request_phases.AccessRequestPhases( + started = '2020-07-11T00:00Z', + finished = '2020-07-12T00:00Z', + name = 'APPROVAL_PHASE', + state = 'COMPLETED', + result = 'SUCCESSFUL', + phase_reference = 'approvalDetails', ) + ], +description='This is the Engineering role that engineers are granted.', +remove_date='2019-10-23T00:00Z', +cancelable=True, +access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +client_metadata={key1=value1, key2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..6aed27869 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,40 @@ +--- +id: v2024-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'V2024RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/python/v2024/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'V2024RequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_status_cancelled_request_details import RequestedItemStatusCancelledRequestDetails + +requested_item_status_cancelled_request_details = RequestedItemStatusCancelledRequestDetails( +comment='This request must be cancelled.', +owner=sailpoint.v2024.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +modified='2019-12-20T09:17:12.192Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..71c285c42 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2024RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/python/v2024/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2024RequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment left for the pre-approval decision | [optional] +**reviewer** | **str** | The reviewer of the pre-approval decision | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | The decision of the pre-approval trigger | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_status_pre_approval_trigger_details import RequestedItemStatusPreApprovalTriggerDetails + +requested_item_status_pre_approval_trigger_details = RequestedItemStatusPreApprovalTriggerDetails( +comment='Access is Approved', +reviewer='John Doe', +decision='APPROVED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..414441b44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,33 @@ +--- +id: v2024-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusProvisioningDetails', 'V2024RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/python/v2024/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'V2024RequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ordered_sub_phase_references** | **str** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_status_provisioning_details import RequestedItemStatusProvisioningDetails + +requested_item_status_provisioning_details = RequestedItemStatusProvisioningDetails( +ordered_sub_phase_references='manualWorkItemDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..a6e85e568 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,37 @@ +--- +id: v2024-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequestState', 'V2024RequestedItemStatusRequestState'] +slug: /tools/sdk/python/v2024/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'V2024RequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. + +## Enum + +* `EXECUTING` (value: `'EXECUTING'`) + +* `REQUEST_COMPLETED` (value: `'REQUEST_COMPLETED'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +* `TERMINATED` (value: `'TERMINATED'`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `'PROVISIONING_VERIFICATION_PENDING'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `PROVISIONING_FAILED` (value: `'PROVISIONING_FAILED'`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `'NOT_ALL_ITEMS_PROVISIONED'`) + +* `ERROR` (value: `'ERROR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..d0a8cc635 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,38 @@ +--- +id: v2024-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequestedFor', 'V2024RequestedItemStatusRequestedFor'] +slug: /tools/sdk/python/v2024/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'V2024RequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +Identity access was requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | 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.requested_item_status_requested_for import RequestedItemStatusRequestedFor + +requested_item_status_requested_for = RequestedItemStatusRequestedFor( +type='IDENTITY', +id='2c9180835d191a86015d28455b4b232a', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..450e6f867 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,40 @@ +--- +id: v2024-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequesterComment', 'V2024RequestedItemStatusRequesterComment'] +slug: /tools/sdk/python/v2024/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'V2024RequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_status_requester_comment import RequestedItemStatusRequesterComment + +requested_item_status_requester_comment = RequestedItemStatusRequesterComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v2024.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..5dad0a398 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,64 @@ +--- +id: v2024-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusSodViolationContext', 'V2024RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/python/v2024/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'V2024RequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_status_sod_violation_context import RequestedItemStatusSodViolationContext + +requested_item_status_sod_violation_context = RequestedItemStatusSodViolationContext( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.v2024.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v2024.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ResourceObject.md b/docs/tools/sdk/python/Reference/V2024/Models/ResourceObject.md new file mode 100644 index 000000000..4e6dee949 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ResourceObject.md @@ -0,0 +1,58 @@ +--- +id: v2024-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceObject', 'V2024ResourceObject'] +slug: /tools/sdk/python/v2024/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'V2024ResourceObject'] +--- + +# ResourceObject + +Representation of the object which is returned from source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instance** | **str** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**identity** | **str** | Native identity of the object in the Source. | [optional] [readonly] +**uuid** | **str** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**previous_identity** | **str** | Native identity that the object has previously. | [optional] [readonly] +**name** | **str** | Display name for this object. | [optional] [readonly] +**object_type** | **str** | Type of object. | [optional] [readonly] +**incomplete** | **bool** | 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. | [optional] [readonly] +**incremental** | **bool** | 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. | [optional] [readonly] +**delete** | **bool** | 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. | [optional] [readonly] +**remove** | **bool** | 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. | [optional] [readonly] +**missing** | **[]str** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [optional] [readonly] +**attributes** | **object** | Attributes of this ResourceObject. | [optional] [readonly] +**final_update** | **bool** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.resource_object import ResourceObject + +resource_object = ResourceObject( +instance='', +identity='CN=Aaron Carr,OU=test1,DC=test2,DC=test', +uuid='{abf7bd9b-68b4-4d21-9b70-870c58ebf844}', +previous_identity='', +name='Aaron Carr', +object_type='account', +incomplete=False, +incremental=False, +delete=False, +remove=False, +missing=[missFieldOne, missFieldTwo], +attributes={telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr}, +final_update=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ResourceObjectsRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..2f839f540 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ResourceObjectsRequest.md @@ -0,0 +1,36 @@ +--- +id: v2024-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceObjectsRequest', 'V2024ResourceObjectsRequest'] +slug: /tools/sdk/python/v2024/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'V2024ResourceObjectsRequest'] +--- + +# ResourceObjectsRequest + +Request model for peek resource objects from source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_type** | **str** | The type of resource objects to iterate over. | [optional] [default to 'account'] +**max_count** | **int** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] +} + +## Example + +```python +from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest + +resource_objects_request = ResourceObjectsRequest( +object_type='account', +max_count=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ResourceObjectsResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..0c3d947ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ResourceObjectsResponse.md @@ -0,0 +1,57 @@ +--- +id: v2024-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ResourceObjectsResponse', 'V2024ResourceObjectsResponse'] +slug: /tools/sdk/python/v2024/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'V2024ResourceObjectsResponse'] +--- + +# ResourceObjectsResponse + +Response model for peek resource objects from source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the source | [optional] [readonly] +**name** | **str** | Name of the source | [optional] [readonly] +**object_count** | **int** | The number of objects that were fetched by the connector. | [optional] [readonly] +**elapsed_millis** | **int** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**resource_objects** | [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse + +resource_objects_response = ResourceObjectsResponse( +id='2c91808568c529c60168cca6f90c1313', +name='ODS-AD-Test [source-999999]', +object_count=25, +elapsed_millis=1055, +resource_objects=[ + sailpoint.v2024.models.resource_object.Resource Object( + instance = '', + identity = 'CN=Aaron Carr,OU=test1,DC=test2,DC=test', + uuid = '{abf7bd9b-68b4-4d21-9b70-870c58ebf844}', + previous_identity = '', + name = 'Aaron Carr', + object_type = 'account', + incomplete = False, + incremental = False, + delete = False, + remove = False, + missing = [missFieldOne, missFieldTwo], + attributes = {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr}, + final_update = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Result.md b/docs/tools/sdk/python/Reference/V2024/Models/Result.md new file mode 100644 index 000000000..97f125855 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Result.md @@ -0,0 +1,33 @@ +--- +id: v2024-result +title: Result +pagination_label: Result +sidebar_label: Result +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Result', 'V2024Result'] +slug: /tools/sdk/python/v2024/models/result +tags: ['SDK', 'Software Development Kit', 'Result', 'V2024Result'] +--- + +# Result + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | Request result status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.result import Result + +result = Result( +status='Manual Task Created' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewDecision.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewDecision.md new file mode 100644 index 000000000..d1bd5bc5c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewDecision.md @@ -0,0 +1,46 @@ +--- +id: v2024-review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewDecision', 'V2024ReviewDecision'] +slug: /tools/sdk/python/v2024/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'V2024ReviewDecision'] +--- + +# ReviewDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the review decision | [required] +**decision** | [**CertificationDecision**](certification-decision) | | [required] +**proposed_end_date** | **datetime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**bulk** | **bool** | Indicates whether decision should be marked as part of a larger bulk decision | [required] +**recommendation** | [**ReviewRecommendation**](review-recommendation) | | [optional] +**comments** | **str** | Comments recorded when the decision was made | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.review_decision import ReviewDecision + +review_decision = ReviewDecision( +id='ef38f94347e94562b5bb8424a56397d8', +decision='APPROVE', +proposed_end_date='2017-07-11T18:45:37.098Z', +bulk=True, +recommendation=sailpoint.v2024.models.review_recommendation.ReviewRecommendation( + recommendation = '', + reasons = [Reason 1, Reason 2], + timestamp = '2020-06-01T13:49:37.385Z', ), +comments='This user no longer needs access to this source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewReassign.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewReassign.md new file mode 100644 index 000000000..72229014b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewReassign.md @@ -0,0 +1,41 @@ +--- +id: v2024-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewReassign', 'V2024ReviewReassign'] +slug: /tools/sdk/python/v2024/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'V2024ReviewReassign'] +--- + +# ReviewReassign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign** | [**[]ReassignReference**](reassign-reference) | | [required] +**reassign_to** | **str** | The ID of the identity to which the certification is reassigned | [required] +**reason** | **str** | The reason comment for why the reassign was made | [required] +} + +## Example + +```python +from sailpoint.v2024.models.review_reassign import ReviewReassign + +review_reassign = ReviewReassign( +reassign=[ + sailpoint.v2024.models.reassign_reference.ReassignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'ITEM', ) + ], +reassign_to='ef38f94347e94562b5bb8424a56397d8', +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewRecommendation.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewRecommendation.md new file mode 100644 index 000000000..b0e2fbe21 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewRecommendation.md @@ -0,0 +1,37 @@ +--- +id: v2024-review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewRecommendation', 'V2024ReviewRecommendation'] +slug: /tools/sdk/python/v2024/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'V2024ReviewRecommendation'] +--- + +# ReviewRecommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommendation** | **str** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**reasons** | **[]str** | A list of reasons for the recommendation. | [optional] +**timestamp** | **datetime** | The time at which the recommendation was recorded. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.review_recommendation import ReviewRecommendation + +review_recommendation = ReviewRecommendation( +recommendation='', +reasons=[Reason 1, Reason 2], +timestamp='2020-06-01T13:49:37.385Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewableAccessProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..e6f1fcd0c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableAccessProfile.md @@ -0,0 +1,104 @@ +--- +id: v2024-reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableAccessProfile', 'V2024ReviewableAccessProfile'] +slug: /tools/sdk/python/v2024/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'V2024ReviewableAccessProfile'] +--- + +# ReviewableAccessProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Access Profile | [optional] +**name** | **str** | Name of the Access Profile | [optional] +**description** | **str** | Information about the Access Profile | [optional] +**privileged** | **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] +**end_date** | **datetime** | The date at which a user's access expires | [optional] +**owner** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**entitlements** | [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created. | [optional] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reviewable_access_profile import ReviewableAccessProfile + +reviewable_access_profile = ReviewableAccessProfile( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +privileged=False, +cloud_governed=False, +end_date='2021-12-25T00:00Z', +owner=sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +entitlements=[ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], +created='2021-01-01T22:32:58.104Z', +modified='2021-02-01T22:32:58.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..e4b948a20 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlement.md @@ -0,0 +1,99 @@ +--- +id: v2024-reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableEntitlement', 'V2024ReviewableEntitlement'] +slug: /tools/sdk/python/v2024/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'V2024ReviewableEntitlement'] +--- + +# ReviewableEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id for the entitlement | [optional] +**name** | **str** | The name of the entitlement | [optional] +**description** | **str** | Information about the entitlement | [optional] +**privileged** | **bool** | Indicates if the entitlement is a privileged entitlement | [optional] [default to False] +**owner** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**attribute_name** | **str** | The name of the attribute on the source | [optional] +**attribute_value** | **str** | The value of the attribute on the source | [optional] +**source_schema_object_type** | **str** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**source_name** | **str** | The name of the source for which this entitlement belongs | [optional] +**source_type** | **str** | The type of the source for which the entitlement belongs | [optional] +**source_id** | **str** | The ID of the source for which the entitlement belongs | [optional] +**has_permissions** | **bool** | Indicates if the entitlement has permissions | [optional] [default to False] +**is_permission** | **bool** | Indicates if the entitlement is a representation of an account permission | [optional] [default to False] +**revocable** | **bool** | Indicates whether the entitlement can be revoked | [optional] [default to False] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] [default to False] +**contains_data_access** | **bool** | True if the entitlement has DAS data | [optional] [default to False] +**data_access** | [**DataAccess**](data-access) | | [optional] +**account** | [**ReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reviewable_entitlement import ReviewableEntitlement + +reviewable_entitlement = ReviewableEntitlement( +id='2c918085718230600171993742c63558', +name='CN=entitlement.bbb7c650', +description='Gives read/write access to the company database', +privileged=False, +owner=sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +attribute_name='memberOf', +attribute_value='CN=entitlement.bbb7c650', +source_schema_object_type='groups', +source_name='ODS-AD-Source', +source_type='Active Directory - Direct', +source_id='78ca6be511cb41fbb86dba2fcca7780c', +has_permissions=False, +is_permission=False, +revocable=True, +cloud_governed=False, +contains_data_access=True, +data_access=sailpoint.v2024.models.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', ), ), +account=sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', + owner = sailpoint.v2024.models.reviewable_entitlement_account_owner.ReviewableEntitlement_account_owner( + id = '2c9180857182305e0171993737eb29e8', + display_name = 'Alison Ferguson', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..57d8e7ec1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,62 @@ +--- +id: v2024-reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableEntitlementAccount', 'V2024ReviewableEntitlementAccount'] +slug: /tools/sdk/python/v2024/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'V2024ReviewableEntitlementAccount'] +--- + +# ReviewableEntitlementAccount + +Information about the status of the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**native_identity** | **str** | The native identity for this account | [optional] +**disabled** | **bool** | Indicates whether this account is currently disabled | [optional] [default to False] +**locked** | **bool** | Indicates whether this account is currently locked | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The id associated with the account | [optional] +**name** | **str** | The account name | [optional] +**created** | **datetime** | When the account was created | [optional] +**modified** | **datetime** | When the account was last modified | [optional] +**activity_insights** | [**ActivityInsights**](activity-insights) | | [optional] +**description** | **str** | Information about the account | [optional] +**governance_group_id** | **str** | The id associated with the machine Account Governance Group | [optional] +**owner** | [**ReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reviewable_entitlement_account import ReviewableEntitlementAccount + +reviewable_entitlement_account = ReviewableEntitlementAccount( +native_identity='CN=Alison Ferguso', +disabled=False, +locked=False, +type='IDENTITY', +id='2c9180857182305e0171993737eb29e6', +name='Alison Ferguso', +created='2020-04-20T20:11:05.067Z', +modified='2020-05-20T18:57:16.987Z', +activity_insights=sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), +description='Account for Read/write to the company database', +governance_group_id='2c9180857182305e0171993737eb29e6', +owner=sailpoint.v2024.models.reviewable_entitlement_account_owner.ReviewableEntitlement_account_owner( + id = '2c9180857182305e0171993737eb29e8', + type = 'IDENTITY', + display_name = 'Alison Ferguson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..bccff7dcb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableEntitlementAccountOwner', 'V2024ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/python/v2024/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'V2024ReviewableEntitlementAccountOwner'] +--- + +# ReviewableEntitlementAccountOwner + +Information about the machine account owner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id associated with the machine account owner | [optional] +**type** | **Enum** [ 'IDENTITY' ] | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**display_name** | **str** | The machine account owner's display name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reviewable_entitlement_account_owner import ReviewableEntitlementAccountOwner + +reviewable_entitlement_account_owner = ReviewableEntitlementAccountOwner( +id='2c9180857182305e0171993737eb29e8', +type='IDENTITY', +display_name='Alison Ferguson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ReviewableRole.md b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableRole.md new file mode 100644 index 000000000..7ec68634e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ReviewableRole.md @@ -0,0 +1,162 @@ +--- +id: v2024-reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableRole', 'V2024ReviewableRole'] +slug: /tools/sdk/python/v2024/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'V2024ReviewableRole'] +--- + +# ReviewableRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id for the Role | [optional] +**name** | **str** | The name of the Role | [optional] +**description** | **str** | Information about the Role | [optional] +**privileged** | **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**owner** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**revocable** | **bool** | Indicates whether the Role can be revoked or requested | [optional] +**end_date** | **datetime** | The date when a user's access expires. | [optional] +**access_profiles** | [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**entitlements** | [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reviewable_role import ReviewableRole + +reviewable_role = ReviewableRole( +id='2c91808a7190d06e0171993907fd0794', +name='Accounting-Employees', +description='Role for members of the accounting department with the necessary Access Profiles', +privileged=False, +owner=sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +revocable=False, +end_date='2021-12-25T00:00Z', +access_profiles=[ + sailpoint.v2024.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + entitlements = [ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ) + ], +entitlements=[ + sailpoint.v2024.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v2024.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v2024.models.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', ), ), + account = sailpoint.v2024.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v2024.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Reviewer.md b/docs/tools/sdk/python/Reference/V2024/Models/Reviewer.md new file mode 100644 index 000000000..64922bb23 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Reviewer.md @@ -0,0 +1,43 @@ +--- +id: v2024-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reviewer', 'V2024Reviewer'] +slug: /tools/sdk/python/v2024/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'V2024Reviewer'] +--- + +# Reviewer + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the reviewer. | [optional] +**name** | **str** | The name of the reviewer. | [optional] +**email** | **str** | The email of the reviewing identity. | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the reviewing identity. | [optional] +**created** | **datetime** | The created date of the reviewing identity. | [optional] +**modified** | **datetime** | The modified date of the reviewing identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.reviewer import Reviewer + +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md b/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md new file mode 100644 index 000000000..3a5f1fa7b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md @@ -0,0 +1,37 @@ +--- +id: v2024-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Revocability', 'V2024Revocability'] +slug: /tools/sdk/python/v2024/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] +--- + +# Revocability + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.revocability import Revocability + +revocability = Revocability( +approval_schemes=[ + sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RevocabilityForRole.md b/docs/tools/sdk/python/Reference/V2024/Models/RevocabilityForRole.md new file mode 100644 index 000000000..f58af88c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RevocabilityForRole.md @@ -0,0 +1,41 @@ +--- +id: v2024-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RevocabilityForRole', 'V2024RevocabilityForRole'] +slug: /tools/sdk/python/v2024/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'V2024RevocabilityForRole'] +--- + +# RevocabilityForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.revocability_for_role import RevocabilityForRole + +revocability_for_role = RevocabilityForRole( +comments_required=False, +denial_comments_required=False, +approval_schemes=[ + sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Role.md b/docs/tools/sdk/python/Reference/V2024/Models/Role.md new file mode 100644 index 000000000..550fe2335 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Role.md @@ -0,0 +1,119 @@ +--- +id: v2024-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Role', 'V2024Role'] +slug: /tools/sdk/python/v2024/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'V2024Role'] +--- + +# Role + +A Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**name** | **str** | The human-readable display name of the Role | [required] +**created** | **datetime** | Date the Role was created | [optional] [readonly] +**modified** | **datetime** | Date the Role was last modified. | [optional] [readonly] +**description** | **str** | A human-readable description of the Role | [optional] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**access_profiles** | [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | | [optional] +**membership** | [**RoleMembershipSelector**](role-membership-selector) | | [optional] +**legacy_membership_info** | **map[string]object** | 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. | [optional] +**enabled** | **bool** | Whether the Role is enabled or not. | [optional] [default to False] +**requestable** | **bool** | Whether the Role can be the target of access requests. | [optional] [default to False] +**access_request_config** | [**RequestabilityForRole**](requestability-for-role) | | [optional] +**revocation_request_config** | [**RevocabilityForRole**](revocability-for-role) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**dimensional** | **bool** | Whether the Role is dimensional. | [optional] [default to False] +**dimension_refs** | [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**access_model_metadata** | [**AttributeDTOList**](attribute-dto-list) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role import Role + +role = Role( +id='2c918086749d78830174a1a40e121518', +name='Role 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.role_membership_selector.RoleMembershipSelector( + type = 'IDENTITY_LIST', + criteria = sailpoint.v2024.models.role_criteria_level1.RoleCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v2024.models.role_criteria_level2.RoleCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), + identities = [ + sailpoint.v2024.models.role_membership_identity.RoleMembershipIdentity( + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', + alias_name = 't.edison', ) + ], ), +legacy_membership_info={type=IDENTITY_LIST}, +enabled=True, +requestable=True, +access_request_config=sailpoint.v2024.models.requestability_for_role.RequestabilityForRole( + comments_required = True, + denial_comments_required = True, + approval_schemes = [ + sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +revocation_request_config=sailpoint.v2024.models.revocability_for_role.RevocabilityForRole( + comments_required = False, + denial_comments_required = False, + approval_schemes = [ + sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +dimensional=True, +dimension_refs=[ + sailpoint.v2024.models.dimension_ref.DimensionRef( + type = 'DIMENSION', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Role 2', ) + ], +access_model_metadata=sailpoint.v2024.models.attribute_dto_list.AttributeDTOList( + 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}]}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..c5393108f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDto.md @@ -0,0 +1,66 @@ +--- +id: v2024-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentDto', 'V2024RoleAssignmentDto'] +slug: /tools/sdk/python/v2024/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'V2024RoleAssignmentDto'] +--- + +# RoleAssignmentDto + + +## 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.role_assignment_dto import RoleAssignmentDto + +role_assignment_dto = RoleAssignmentDto( +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/RoleAssignmentDtoAssigner.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDtoAssigner.md new file mode 100644 index 000000000..22030bf37 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDtoAssigner.md @@ -0,0 +1,38 @@ +--- +id: v2024-role-assignment-dto-assigner +title: RoleAssignmentDtoAssigner +pagination_label: RoleAssignmentDtoAssigner +sidebar_label: RoleAssignmentDtoAssigner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentDtoAssigner', 'V2024RoleAssignmentDtoAssigner'] +slug: /tools/sdk/python/v2024/models/role-assignment-dto-assigner +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDtoAssigner', 'V2024RoleAssignmentDtoAssigner'] +--- + +# RoleAssignmentDtoAssigner + +The identity that performed the assignment. This could be blank or system + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'UNKNOWN' ] | Object 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.role_assignment_dto_assigner import RoleAssignmentDtoAssigner + +role_assignment_dto_assigner = RoleAssignmentDtoAssigner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDtoAssignmentContext.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDtoAssignmentContext.md new file mode 100644 index 000000000..828b71bc0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentDtoAssignmentContext.md @@ -0,0 +1,55 @@ +--- +id: v2024-role-assignment-dto-assignment-context +title: RoleAssignmentDtoAssignmentContext +pagination_label: RoleAssignmentDtoAssignmentContext +sidebar_label: RoleAssignmentDtoAssignmentContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentDtoAssignmentContext', 'V2024RoleAssignmentDtoAssignmentContext'] +slug: /tools/sdk/python/v2024/models/role-assignment-dto-assignment-context +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDtoAssignmentContext', 'V2024RoleAssignmentDtoAssignmentContext'] +--- + +# RoleAssignmentDtoAssignmentContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested** | [**AccessRequestContext**](access-request-context) | | [optional] +**matched** | [**[]RoleMatchDto**](role-match-dto) | | [optional] +**computed_date** | **str** | Date that the assignment will was evaluated | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_assignment_dto_assignment_context import RoleAssignmentDtoAssignmentContext + +role_assignment_dto_assignment_context = RoleAssignmentDtoAssignmentContext( +requested=sailpoint.v2024.models.access_request_context.AccessRequestContext( + context_attributes = [ + sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ), +matched=[ + sailpoint.v2024.models.role_match_dto.RoleMatchDto( + role_ref = sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + matched_attributes = [ + sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ], ) + ], +computed_date='Wed Feb 14 10:58:42' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..312549f22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentRef.md @@ -0,0 +1,38 @@ +--- +id: v2024-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentRef', 'V2024RoleAssignmentRef'] +slug: /tools/sdk/python/v2024/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'V2024RoleAssignmentRef'] +--- + +# RoleAssignmentRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Assignment Id | [optional] +**role** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_assignment_ref import RoleAssignmentRef + +role_assignment_ref = RoleAssignmentRef( +id='1cbb0705b38c4226b1334eadd8874086', +role=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..3d6200106 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleAssignmentSourceType.md @@ -0,0 +1,23 @@ +--- +id: v2024-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentSourceType', 'V2024RoleAssignmentSourceType'] +slug: /tools/sdk/python/v2024/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'V2024RoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +Type which indicates how a particular Identity obtained a particular Role + +## Enum + +* `ACCESS_REQUEST` (value: `'ACCESS_REQUEST'`) + +* `ROLE_MEMBERSHIP` (value: `'ROLE_MEMBERSHIP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..471c93985 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleBulkDeleteRequest', 'V2024RoleBulkDeleteRequest'] +slug: /tools/sdk/python/v2024/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'V2024RoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_ids** | **[]str** | List of IDs of Roles to be deleted. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.role_bulk_delete_request import RoleBulkDeleteRequest + +role_bulk_delete_request = RoleBulkDeleteRequest( +role_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleBulkUpdateResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleBulkUpdateResponse.md new file mode 100644 index 000000000..5ed38baa2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleBulkUpdateResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-bulk-update-response +title: RoleBulkUpdateResponse +pagination_label: RoleBulkUpdateResponse +sidebar_label: RoleBulkUpdateResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleBulkUpdateResponse', 'V2024RoleBulkUpdateResponse'] +slug: /tools/sdk/python/v2024/models/role-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleBulkUpdateResponse', 'V2024RoleBulkUpdateResponse'] +--- + +# RoleBulkUpdateResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. | [optional] +**type** | **str** | Type of the bulk update object. | [optional] +**status** | **Enum** [ 'CREATED', 'PRE_PROCESS', 'PRE_PROCESS_COMPLETED', 'POST_PROCESS', 'COMPLETED', 'CHUNK_PENDING', 'CHUNK_PROCESSING' ] | The status of the bulk update request, could also checked by getBulkUpdateStatus API | [optional] +**created** | **datetime** | Time when the bulk update request was created | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse + +role_bulk_update_response = RoleBulkUpdateResponse( +id='2c9180867817ac4d017817c491119a20', +type='Role', +status='CREATED', +created='2020-10-08T18:33:52.029Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKey.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..8e1a5ffd7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKey.md @@ -0,0 +1,38 @@ +--- +id: v2024-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaKey', 'V2024RoleCriteriaKey'] +slug: /tools/sdk/python/v2024/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'V2024RoleCriteriaKey'] +--- + +# RoleCriteriaKey + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] +**var_property** | **str** | The name of the attribute or entitlement to which the associated criteria applies. | [required] +**source_id** | **str** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_criteria_key import RoleCriteriaKey + +role_criteria_key = RoleCriteriaKey( +type='ACCOUNT', +var_property='attribute.email', +source_id='2c9180867427f3a301745aec18211519' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..15061092a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKeyType.md @@ -0,0 +1,25 @@ +--- +id: v2024-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaKeyType', 'V2024RoleCriteriaKeyType'] +slug: /tools/sdk/python/v2024/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'V2024RoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. + +## Enum + +* `IDENTITY` (value: `'IDENTITY'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..72369d83c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel1.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel1', 'V2024RoleCriteriaLevel1'] +slug: /tools/sdk/python/v2024/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'V2024RoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +**children** | [**[]RoleCriteriaLevel2**](role-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.role_criteria_level1 import RoleCriteriaLevel1 + +role_criteria_level1 = RoleCriteriaLevel1( +operation='EQUALS', +key=sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v2024.models.role_criteria_level2.RoleCriteriaLevel2( + operation = 'EQUALS', + key = sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..53284e96d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel2.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel2', 'V2024RoleCriteriaLevel2'] +slug: /tools/sdk/python/v2024/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'V2024RoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +**children** | [**[]RoleCriteriaLevel3**](role-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.role_criteria_level2 import RoleCriteriaLevel2 + +role_criteria_level2 = RoleCriteriaLevel2( +operation='EQUALS', +key=sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v2024.models.role_criteria_level3.RoleCriteriaLevel3( + operation = 'EQUALS', + key = sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..763824963 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaLevel3.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel3', 'V2024RoleCriteriaLevel3'] +slug: /tools/sdk/python/v2024/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'V2024RoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_criteria_level3 import RoleCriteriaLevel3 + +role_criteria_level3 = RoleCriteriaLevel3( +operation='EQUALS', +key=sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..c697f31cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaOperation.md @@ -0,0 +1,33 @@ +--- +id: v2024-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaOperation', 'V2024RoleCriteriaOperation'] +slug: /tools/sdk/python/v2024/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'V2024RoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +An operation + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `STARTS_WITH` (value: `'STARTS_WITH'`) + +* `ENDS_WITH` (value: `'ENDS_WITH'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocument.md new file mode 100644 index 000000000..d1a34414b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocument.md @@ -0,0 +1,106 @@ +--- +id: v2024-role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocument', 'V2024RoleDocument'] +slug: /tools/sdk/python/v2024/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'V2024RoleDocument'] +--- + +# RoleDocument + +Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Access item's description. | [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] +**synced** | **datetime** | 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] +**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False] +**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True] +**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False] +**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional] +**id** | **str** | ID of the role. | [required] +**name** | **str** | Name of the role. | [required] +**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**access_profile_count** | **int** | Number of access profiles included with the role. | [optional] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**segment_count** | **int** | Number of segments with the role. | [optional] +**entitlements** | [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional] +**entitlement_count** | **int** | Number of entitlements included with the role. | [optional] +**dimensional** | **bool** | | [optional] [default to False] +**dimension_schema_attribute_count** | **int** | Number of dimension attributes included with the role. | [optional] +**dimension_schema_attributes** | [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional] +**dimensions** | [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_document import RoleDocument + +role_document = RoleDocument( +description='Admin access', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:33.104Z', +enabled=True, +requestable=True, +request_comments_required=False, +owner=sailpoint.v2024.models.base_access_owner.BaseAccess_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', + email = 'cloud-support@sailpoint.com', ), +id='2c91808375d8e80a0175e1f88a575222', +name='Branch Manager Access', +access_profiles=[ + sailpoint.v2024.models.base_access_profile.BaseAccessProfile( + id = '2c91809c6faade77016fb4f0b63407ae', + name = 'Admin Access', ) + ], +access_profile_count=1, +tags=[TAG_1, TAG_2], +segments=[ + sailpoint.v2024.models.base_segment.BaseSegment( + id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', + name = 'Test Segment', ) + ], +segment_count=1, +entitlements=[ + null + ], +entitlement_count=3, +dimensional=False, +dimension_schema_attribute_count=3, +dimension_schema_attributes=[ + sailpoint.v2024.models.role_document_all_of_dimension_schema_attributes.RoleDocument_allOf_dimensionSchemaAttributes( + derived = True, + display_name = 'Department', + name = 'department', ) + ], +dimensions=[ + sailpoint.v2024.models.role_document_all_of_dimensions.RoleDocument_allOf_dimensions( + id = 'b3c28992ba964a40a7598978139d1ced', + name = 'Manager Austin Branch', + description = 'Managers located at the Austin branch', + entitlements = [ + null + ], + access_profiles = [ + sailpoint.v2024.models.base_access_profile.BaseAccessProfile( + id = '2c91809c6faade77016fb4f0b63407ae', + name = 'Admin Access', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfDimensionSchemaAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfDimensionSchemaAttributes.md new file mode 100644 index 000000000..2924b1c51 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfDimensionSchemaAttributes.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-document-all-of-dimension-schema-attributes +title: RoleDocumentAllOfDimensionSchemaAttributes +pagination_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2024RoleDocumentAllOfDimensionSchemaAttributes'] +slug: /tools/sdk/python/v2024/models/role-document-all-of-dimension-schema-attributes +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2024RoleDocumentAllOfDimensionSchemaAttributes'] +--- + +# RoleDocumentAllOfDimensionSchemaAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**derived** | **bool** | | [optional] [default to True] +**display_name** | **str** | Displayname of the dimension attribute. | [optional] +**name** | **str** | Name of the dimension attribute. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_document_all_of_dimension_schema_attributes import RoleDocumentAllOfDimensionSchemaAttributes + +role_document_all_of_dimension_schema_attributes = RoleDocumentAllOfDimensionSchemaAttributes( +derived=True, +display_name='Department', +name='department' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfDimensions.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfDimensions.md new file mode 100644 index 000000000..adda11673 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfDimensions.md @@ -0,0 +1,47 @@ +--- +id: v2024-role-document-all-of-dimensions +title: RoleDocumentAllOfDimensions +pagination_label: RoleDocumentAllOfDimensions +sidebar_label: RoleDocumentAllOfDimensions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfDimensions', 'V2024RoleDocumentAllOfDimensions'] +slug: /tools/sdk/python/v2024/models/role-document-all-of-dimensions +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'V2024RoleDocumentAllOfDimensions'] +--- + +# RoleDocumentAllOfDimensions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID of the dimension. | [optional] +**name** | **str** | Name of the dimension. | [optional] +**description** | **str** | Description of the dimension. | [optional] +**entitlements** | [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional] +**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_document_all_of_dimensions import RoleDocumentAllOfDimensions + +role_document_all_of_dimensions = RoleDocumentAllOfDimensions( +id='b3c28992ba964a40a7598978139d1ced', +name='Manager Austin Branch', +description='Managers located at the Austin branch', +entitlements=[ + null + ], +access_profiles=[ + sailpoint.v2024.models.base_access_profile.BaseAccessProfile( + id = '2c91809c6faade77016fb4f0b63407ae', + name = 'Admin Access', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md new file mode 100644 index 000000000..27f1f28fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-document-all-of-entitlements +title: RoleDocumentAllOfEntitlements +pagination_label: RoleDocumentAllOfEntitlements +sidebar_label: RoleDocumentAllOfEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfEntitlements', 'V2024RoleDocumentAllOfEntitlements'] +slug: /tools/sdk/python/v2024/models/role-document-all-of-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'V2024RoleDocumentAllOfEntitlements'] +--- + +# RoleDocumentAllOfEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False] +**description** | **str** | Entitlement's description. | [optional] +**attribute** | **str** | Entitlement attribute's name. | [optional] +**value** | **str** | Entitlement's value. | [optional] +**var_schema** | **str** | Entitlement's schema. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's name. | [optional] +**source_schema_object_type** | **str** | Schema objectType. | [optional] +**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_document_all_of_entitlements import RoleDocumentAllOfEntitlements + +role_document_all_of_entitlements = RoleDocumentAllOfEntitlements( +has_permissions=False, +description='Cloud engineering', +attribute='memberOf', +value='CN=Cloud Engineering,DC=sailpoint,DC=COM', +var_schema='group', +privileged=False, +id='2c918084575812550157589064f33b89', +name='CN=Cloud Engineering,DC=sailpoint,DC=COM', +source_schema_object_type='group', +hash='c6fab95235584cca98a454a2f51e5683bc77d6a0' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md new file mode 100644 index 000000000..6d65f98ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-document-all-of-entitlements1 +title: RoleDocumentAllOfEntitlements1 +pagination_label: RoleDocumentAllOfEntitlements1 +sidebar_label: RoleDocumentAllOfEntitlements1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfEntitlements1', 'V2024RoleDocumentAllOfEntitlements1'] +slug: /tools/sdk/python/v2024/models/role-document-all-of-entitlements1 +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'V2024RoleDocumentAllOfEntitlements1'] +--- + +# RoleDocumentAllOfEntitlements1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False] +**description** | **str** | Entitlement's description. | [optional] +**attribute** | **str** | Entitlement attribute's name. | [optional] +**value** | **str** | Entitlement's value. | [optional] +**var_schema** | **str** | Entitlement's schema. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's name. | [optional] +**source_schema_object_type** | **str** | Schema objectType. | [optional] +**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_document_all_of_entitlements1 import RoleDocumentAllOfEntitlements1 + +role_document_all_of_entitlements1 = RoleDocumentAllOfEntitlements1( +has_permissions=False, +description='Cloud engineering', +attribute='memberOf', +value='CN=Cloud Engineering,DC=sailpoint,DC=COM', +var_schema='group', +privileged=False, +id='2c918084575812550157589064f33b89', +name='CN=Cloud Engineering,DC=sailpoint,DC=COM', +source_schema_object_type='group', +hash='c6fab95235584cca98a454a2f51e5683bc77d6a0' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleGetAllBulkUpdateResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleGetAllBulkUpdateResponse.md new file mode 100644 index 000000000..8183fb1ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleGetAllBulkUpdateResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-get-all-bulk-update-response +title: RoleGetAllBulkUpdateResponse +pagination_label: RoleGetAllBulkUpdateResponse +sidebar_label: RoleGetAllBulkUpdateResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleGetAllBulkUpdateResponse', 'V2024RoleGetAllBulkUpdateResponse'] +slug: /tools/sdk/python/v2024/models/role-get-all-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleGetAllBulkUpdateResponse', 'V2024RoleGetAllBulkUpdateResponse'] +--- + +# RoleGetAllBulkUpdateResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. | [optional] +**type** | **str** | Type of the bulk update object. | [optional] +**status** | **Enum** [ 'CREATED', 'PRE_PROCESS', 'POST_PROCESS', 'CHUNK_PENDING', 'CHUNK_PROCESSING' ] | The status of the bulk update request, only list unfinished request's status, the status could also checked by getBulkUpdateStatus API | [optional] +**created** | **datetime** | Time when the bulk update request was created | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_get_all_bulk_update_response import RoleGetAllBulkUpdateResponse + +role_get_all_bulk_update_response = RoleGetAllBulkUpdateResponse( +id='2c9180867817ac4d017817c491119a20', +type='Role', +status='CREATED', +created='2020-10-08T18:33:52.029Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleIdentity.md new file mode 100644 index 000000000..583173f3d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleIdentity.md @@ -0,0 +1,42 @@ +--- +id: v2024-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleIdentity', 'V2024RoleIdentity'] +slug: /tools/sdk/python/v2024/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'V2024RoleIdentity'] +--- + +# RoleIdentity + +A subset of the fields of an Identity which is a member of a Role. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Identity | [optional] +**alias_name** | **str** | The alias / username of the Identity | [optional] +**name** | **str** | The human-readable display name of the Identity | [optional] +**email** | **str** | Email address of the Identity | [optional] +**role_assignment_source** | [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_identity import RoleIdentity + +role_identity = RoleIdentity( +id='2c9180a46faadee4016fb4e018c20639', +alias_name='t.edison', +name='Thomas Edison', +email='t.edison@identitynow.com', +role_assignment_source='ACCESS_REQUEST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsight.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsight.md new file mode 100644 index 000000000..7fecdb49e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsight.md @@ -0,0 +1,53 @@ +--- +id: v2024-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsight', 'V2024RoleInsight'] +slug: /tools/sdk/python/v2024/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'V2024RoleInsight'] +--- + +# RoleInsight + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Insight id | [optional] +**number_of_updates** | **int** | Total number of updates for this role | [optional] +**created_date** | **datetime** | The date-time insights were last created for this role. | [optional] +**modified_date** | **datetime** | The date-time insights were last modified for this role. | [optional] +**role** | [**RoleInsightsRole**](role-insights-role) | | [optional] +**insight** | [**RoleInsightsInsight**](role-insights-insight) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insight import RoleInsight + +role_insight = RoleInsight( +id='1467e61e-f284-439c-ba2d-c6cc11cf0941', +number_of_updates=5, +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date='2020-05-19T13:49:37.385Z', +role=sailpoint.v2024.models.role_insights_role.RoleInsightsRole( + name = 'Software Engineer', + id = '1467e61e-f284-439c-ba2d-c6cc11cf0941', + description = 'Person who develops software', + owner_name = 'Bob', + owner_id = '1467e61e-f284-439c-ba2d-c6cc11cf0941', ), +insight=sailpoint.v2024.models.role_insights_insight.RoleInsightsInsight( + type = 'ADD', + identities_with_access = 850, + identities_impacted = 150, + total_number_of_identities = 1000, + impacted_identity_names = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..f8e99a34d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsEntitlement.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsEntitlement', 'V2024RoleInsightsEntitlement'] +slug: /tools/sdk/python/v2024/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'V2024RoleInsightsEntitlement'] +--- + +# RoleInsightsEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the entitlement | [optional] +**id** | **str** | Id of the entitlement | [optional] +**description** | **str** | Description for the entitlement | [optional] +**source** | **str** | Source or the application for the entitlement | [optional] +**attribute** | **str** | Attribute for the entitlement | [optional] +**value** | **str** | Attribute value for the entitlement | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_entitlement import RoleInsightsEntitlement + +role_insights_entitlement = RoleInsightsEntitlement( +name='Administrator', +id='8c190e67-87aa-4ed9-a90b-d9d5344523fb', +description='Full administrative access to IdentityNow', +source='IdentityNow', +attribute='assignedGroups', +value='ORG_ADMIN' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..4ed28ed56 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,50 @@ +--- +id: v2024-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsEntitlementChanges', 'V2024RoleInsightsEntitlementChanges'] +slug: /tools/sdk/python/v2024/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'V2024RoleInsightsEntitlementChanges'] +--- + +# RoleInsightsEntitlementChanges + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the entitlement | [optional] +**id** | **str** | Id of the entitlement | [optional] +**description** | **str** | Description for the entitlement | [optional] +**attribute** | **str** | Attribute for the entitlement | [optional] +**value** | **str** | Attribute value for the entitlement | [optional] +**source** | **str** | Source or the application for the entitlement | [optional] +**insight** | [**RoleInsightsInsight**](role-insights-insight) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges + +role_insights_entitlement_changes = RoleInsightsEntitlementChanges( +name='Administrator', +id='8c190e67-87aa-4ed9-a90b-d9d5344523fb', +description='Full administrative access to IdentityNow', +attribute='assignedGroups', +value='ORG_ADMIN', +source='IdentityNow', +insight=sailpoint.v2024.models.role_insights_insight.RoleInsightsInsight( + type = 'ADD', + identities_with_access = 850, + identities_impacted = 150, + total_number_of_identities = 1000, + impacted_identity_names = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsIdentities.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..e4995b068 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsIdentities.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsIdentities', 'V2024RoleInsightsIdentities'] +slug: /tools/sdk/python/v2024/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'V2024RoleInsightsIdentities'] +--- + +# RoleInsightsIdentities + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id for identity | [optional] +**name** | **str** | Name for identity | [optional] +**attributes** | **map[string]str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_identities import RoleInsightsIdentities + +role_insights_identities = RoleInsightsIdentities( +id='', +name='', +attributes={ + 'key' : '' + } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsInsight.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..cb761395a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsInsight.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsInsight', 'V2024RoleInsightsInsight'] +slug: /tools/sdk/python/v2024/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'V2024RoleInsightsInsight'] +--- + +# RoleInsightsInsight + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The number of identities in this role with the entitlement. | [optional] +**identities_with_access** | **int** | The number of identities in this role with the entitlement. | [optional] +**identities_impacted** | **int** | The number of identities in this role that do not have the specified entitlement. | [optional] +**total_number_of_identities** | **int** | The total number of identities. | [optional] +**impacted_identity_names** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_insight import RoleInsightsInsight + +role_insights_insight = RoleInsightsInsight( +type='ADD', +identities_with_access=850, +identities_impacted=150, +total_number_of_identities=1000, +impacted_identity_names='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..76d925489 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsResponse.md @@ -0,0 +1,45 @@ +--- +id: v2024-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsResponse', 'V2024RoleInsightsResponse'] +slug: /tools/sdk/python/v2024/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'V2024RoleInsightsResponse'] +--- + +# RoleInsightsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Request Id for a role insight generation request | [optional] +**created_date** | **datetime** | The date-time role insights request was created. | [optional] +**last_generated** | **datetime** | The date-time role insights request was completed. | [optional] +**number_of_updates** | **int** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**role_ids** | **[]str** | The role IDs that are in this request. | [optional] +**status** | **Enum** [ 'CREATED', 'IN PROGRESS', 'COMPLETED', 'FAILED' ] | Request status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse + +role_insights_response = RoleInsightsResponse( +id='8c190e67-87aa-4ed9-a90b-d9d5344523fb', +created_date='2020-09-16T18:49:32.150Z', +last_generated='2020-09-16T18:50:12.150Z', +number_of_updates=0, +role_ids=[ + '' + ], +status='CREATED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsRole.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsRole.md new file mode 100644 index 000000000..81f59b9d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsRole.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsRole', 'V2024RoleInsightsRole'] +slug: /tools/sdk/python/v2024/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'V2024RoleInsightsRole'] +--- + +# RoleInsightsRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Role name | [optional] +**id** | **str** | Role id | [optional] +**description** | **str** | Role description | [optional] +**owner_name** | **str** | Role owner name | [optional] +**owner_id** | **str** | Role owner id | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_role import RoleInsightsRole + +role_insights_role = RoleInsightsRole( +name='Software Engineer', +id='1467e61e-f284-439c-ba2d-c6cc11cf0941', +description='Person who develops software', +owner_name='Bob', +owner_id='1467e61e-f284-439c-ba2d-c6cc11cf0941' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..d9aab0140 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleInsightsSummary.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleInsightsSummary', 'V2024RoleInsightsSummary'] +slug: /tools/sdk/python/v2024/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'V2024RoleInsightsSummary'] +--- + +# RoleInsightsSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_updates** | **int** | Total number of roles with updates | [optional] +**last_generated** | **datetime** | The date-time role insights were last found. | [optional] +**entitlements_included_in_roles** | **int** | The number of entitlements included in roles (vs free radicals). | [optional] +**total_number_of_entitlements** | **int** | The total number of entitlements. | [optional] +**identities_with_access_via_roles** | **int** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**total_number_of_identities** | **int** | The total number of identities. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_insights_summary import RoleInsightsSummary + +role_insights_summary = RoleInsightsSummary( +number_of_updates=56, +last_generated='2020-05-19T13:49:37.385Z', +entitlements_included_in_roles=45, +total_number_of_entitlements=250, +identities_with_access_via_roles=550, +total_number_of_identities=980 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleListFilterDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleListFilterDTO.md new file mode 100644 index 000000000..c82712a26 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleListFilterDTO.md @@ -0,0 +1,36 @@ +--- +id: v2024-role-list-filter-dto +title: RoleListFilterDTO +pagination_label: RoleListFilterDTO +sidebar_label: RoleListFilterDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleListFilterDTO', 'V2024RoleListFilterDTO'] +slug: /tools/sdk/python/v2024/models/role-list-filter-dto +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTO', 'V2024RoleListFilterDTO'] +--- + +# RoleListFilterDTO + +AMMFilterValues + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | **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] +**amm_key_values** | [**[]RoleListFilterDTOAmmKeyValuesInner**](role-list-filter-dto-amm-key-values-inner) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_list_filter_dto import RoleListFilterDTO + +role_list_filter_dto = RoleListFilterDTO( +filters='dimensional eq false', +amm_key_values=[{attribute=iscFederalClassifications, values=[secret]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleListFilterDTOAmmKeyValuesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleListFilterDTOAmmKeyValuesInner.md new file mode 100644 index 000000000..64b04c58e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleListFilterDTOAmmKeyValuesInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-list-filter-dto-amm-key-values-inner +title: RoleListFilterDTOAmmKeyValuesInner +pagination_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleListFilterDTOAmmKeyValuesInner', 'V2024RoleListFilterDTOAmmKeyValuesInner'] +slug: /tools/sdk/python/v2024/models/role-list-filter-dto-amm-key-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTOAmmKeyValuesInner', 'V2024RoleListFilterDTOAmmKeyValuesInner'] +--- + +# RoleListFilterDTOAmmKeyValuesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **str** | attribute key of a metadata. | [optional] +**values** | **[]str** | A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_list_filter_dto_amm_key_values_inner import RoleListFilterDTOAmmKeyValuesInner + +role_list_filter_dto_amm_key_values_inner = RoleListFilterDTOAmmKeyValuesInner( +attribute='iscFederalClassifications', +values=[secret] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMatchDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMatchDto.md new file mode 100644 index 000000000..9c93e8c1e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMatchDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMatchDto', 'V2024RoleMatchDto'] +slug: /tools/sdk/python/v2024/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'V2024RoleMatchDto'] +--- + +# RoleMatchDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_ref** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +**matched_attributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_match_dto import RoleMatchDto + +role_match_dto = RoleMatchDto( +role_ref=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +matched_attributes=[ + sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto( + attribute = 'location', + value = Austin, + derived = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..7cef7216f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipIdentity.md @@ -0,0 +1,40 @@ +--- +id: v2024-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipIdentity', 'V2024RoleMembershipIdentity'] +slug: /tools/sdk/python/v2024/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'V2024RoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +A reference to an Identity in an IDENTITY_LIST role membership criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of the Identity. | [optional] +**alias_name** | **str** | User name of the Identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_membership_identity import RoleMembershipIdentity + +role_membership_identity = RoleMembershipIdentity( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison', +alias_name='t.edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipSelector.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..8cb787e16 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipSelector.md @@ -0,0 +1,54 @@ +--- +id: v2024-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipSelector', 'V2024RoleMembershipSelector'] +slug: /tools/sdk/python/v2024/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'V2024RoleMembershipSelector'] +--- + +# RoleMembershipSelector + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**criteria** | [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**identities** | [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_membership_selector import RoleMembershipSelector + +role_membership_selector = RoleMembershipSelector( +type='IDENTITY_LIST', +criteria=sailpoint.v2024.models.role_criteria_level1.RoleCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.v2024.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v2024.models.role_criteria_level2.RoleCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), +identities=[ + sailpoint.v2024.models.role_membership_identity.RoleMembershipIdentity( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', + alias_name = 't.edison', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..7d20dc8da --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMembershipSelectorType.md @@ -0,0 +1,23 @@ +--- +id: v2024-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipSelectorType', 'V2024RoleMembershipSelectorType'] +slug: /tools/sdk/python/v2024/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'V2024RoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +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 + +## Enum + +* `STANDARD` (value: `'STANDARD'`) + +* `IDENTITY_LIST` (value: `'IDENTITY_LIST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md new file mode 100644 index 000000000..24ce6af45 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-role-metadata-bulk-update-by-filter-request +title: RoleMetadataBulkUpdateByFilterRequest +pagination_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMetadataBulkUpdateByFilterRequest', 'V2024RoleMetadataBulkUpdateByFilterRequest'] +slug: /tools/sdk/python/v2024/models/role-metadata-bulk-update-by-filter-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequest', 'V2024RoleMetadataBulkUpdateByFilterRequest'] +--- + +# RoleMetadataBulkUpdateByFilterRequest + +This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | **str** | 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* | [required] +**operation** | **Enum** [ 'ADD', 'REMOVE', 'REPLACE' ] | The operation to be performed | [required] +**replace_scope** | **Enum** [ 'ALL', 'ATTRIBUTE' ] | The choice of update scope. | [optional] +**values** | [**[]RoleMetadataBulkUpdateByFilterRequestValuesInner**](role-metadata-bulk-update-by-filter-request-values-inner) | The metadata to be updated, including attribute key and value. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.role_metadata_bulk_update_by_filter_request import RoleMetadataBulkUpdateByFilterRequest + +role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest( +filters=' requestable eq false', +operation='REPLACE', +replace_scope='ALL', +values=[{attribute=iscFederalClassifications, values=[topSecret]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md new file mode 100644 index 000000000..fe0bbf65c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-metadata-bulk-update-by-filter-request-values-inner +title: RoleMetadataBulkUpdateByFilterRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2024RoleMetadataBulkUpdateByFilterRequestValuesInner'] +slug: /tools/sdk/python/v2024/models/role-metadata-bulk-update-by-filter-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2024RoleMetadataBulkUpdateByFilterRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByFilterRequestValuesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_key** | **str** | the key of metadata attribute | [optional] +**values** | **[]str** | the values of attribute to be updated | [required] +} + +## Example + +```python +from sailpoint.v2024.models.role_metadata_bulk_update_by_filter_request_values_inner import RoleMetadataBulkUpdateByFilterRequestValuesInner + +role_metadata_bulk_update_by_filter_request_values_inner = RoleMetadataBulkUpdateByFilterRequestValuesInner( +attribute_key='iscFederalClassifications', +values=[secret] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md new file mode 100644 index 000000000..cea6fdad6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-role-metadata-bulk-update-by-id-request +title: RoleMetadataBulkUpdateByIdRequest +pagination_label: RoleMetadataBulkUpdateByIdRequest +sidebar_label: RoleMetadataBulkUpdateByIdRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMetadataBulkUpdateByIdRequest', 'V2024RoleMetadataBulkUpdateByIdRequest'] +slug: /tools/sdk/python/v2024/models/role-metadata-bulk-update-by-id-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequest', 'V2024RoleMetadataBulkUpdateByIdRequest'] +--- + +# RoleMetadataBulkUpdateByIdRequest + +This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**roles** | **[]str** | Roles' Id to be updated | [required] +**operation** | **Enum** [ 'ADD', 'REMOVE', 'REPLACE' ] | The operation to be performed | [required] +**replace_scope** | **Enum** [ 'ALL', 'ATTRIBUTE' ] | The choice of update scope. | [optional] +**values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute key and value. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.role_metadata_bulk_update_by_id_request import RoleMetadataBulkUpdateByIdRequest + +role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest( +roles=[b1db89554cfa431cb8b9921ea38d9367], +operation='REPLACE', +replace_scope='ALL', +values=[{attribute=iscFederalClassifications, values=[topSecret]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md new file mode 100644 index 000000000..96cd3792c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-metadata-bulk-update-by-id-request-values-inner +title: RoleMetadataBulkUpdateByIdRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2024RoleMetadataBulkUpdateByIdRequestValuesInner'] +slug: /tools/sdk/python/v2024/models/role-metadata-bulk-update-by-id-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2024RoleMetadataBulkUpdateByIdRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByIdRequestValuesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **str** | the key of metadata attribute | [required] +**values** | **[]str** | the values of attribute to be updated | [required] +} + +## Example + +```python +from sailpoint.v2024.models.role_metadata_bulk_update_by_id_request_values_inner import RoleMetadataBulkUpdateByIdRequestValuesInner + +role_metadata_bulk_update_by_id_request_values_inner = RoleMetadataBulkUpdateByIdRequestValuesInner( +attribute='iscFederalClassifications', +values=[secret] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md new file mode 100644 index 000000000..d8b24e98f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md @@ -0,0 +1,44 @@ +--- +id: v2024-role-metadata-bulk-update-by-query-request +title: RoleMetadataBulkUpdateByQueryRequest +pagination_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMetadataBulkUpdateByQueryRequest', 'V2024RoleMetadataBulkUpdateByQueryRequest'] +slug: /tools/sdk/python/v2024/models/role-metadata-bulk-update-by-query-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequest', 'V2024RoleMetadataBulkUpdateByQueryRequest'] +--- + +# RoleMetadataBulkUpdateByQueryRequest + +Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **object** | query the identities to be updated | [required] +**operation** | **Enum** [ 'ADD', 'REMOVE', 'REPLACE' ] | The operation to be performed | [required] +**replace_scope** | **Enum** [ 'ALL', 'ATTRIBUTE' ] | The choice of update scope. | [optional] +**values** | [**[]RoleMetadataBulkUpdateByQueryRequestValuesInner**](role-metadata-bulk-update-by-query-request-values-inner) | The metadata to be updated, including attribute key and value. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.role_metadata_bulk_update_by_query_request import RoleMetadataBulkUpdateByQueryRequest + +role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest( +query={query"={indices=[roles], queryType=TEXT, textQuery={terms=[test123], fields=[id], matchAny=false, contains=true}, includeNested=false}}, +operation='REPLACE', +replace_scope='ALL', +values=[ + sailpoint.v2024.models.role_metadata_bulk_update_by_query_request_values_inner.RoleMetadataBulkUpdateByQueryRequest_values_inner( + attribute_key = 'iscFederalClassifications', + attribute_value = [topSecret], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md new file mode 100644 index 000000000..7aa5ee011 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-metadata-bulk-update-by-query-request-values-inner +title: RoleMetadataBulkUpdateByQueryRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2024RoleMetadataBulkUpdateByQueryRequestValuesInner'] +slug: /tools/sdk/python/v2024/models/role-metadata-bulk-update-by-query-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2024RoleMetadataBulkUpdateByQueryRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByQueryRequestValuesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_key** | **str** | the key of metadata attribute | [optional] +**attribute_value** | **[]str** | the values of attribute to be updated | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_metadata_bulk_update_by_query_request_values_inner import RoleMetadataBulkUpdateByQueryRequestValuesInner + +role_metadata_bulk_update_by_query_request_values_inner = RoleMetadataBulkUpdateByQueryRequestValuesInner( +attribute_key='iscFederalClassifications', +attribute_value=[topSecret] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningEntitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..91261c58d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningEntitlement.md @@ -0,0 +1,53 @@ +--- +id: v2024-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningEntitlement', 'V2024RoleMiningEntitlement'] +slug: /tools/sdk/python/v2024/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'V2024RoleMiningEntitlement'] +--- + +# RoleMiningEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlement_ref** | [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**name** | **str** | Name of the entitlement | [optional] +**application_name** | **str** | Application name of the entitlement | [optional] +**identity_count** | **int** | The number of identities with this entitlement in a role. | [optional] +**popularity** | **float** | The % popularity of this entitlement in a role. | [optional] +**popularity_in_org** | **float** | The % popularity of this entitlement in the org. | [optional] +**source_id** | **str** | The ID of the source/application. | [optional] +**activity_source_state** | **str** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**source_usage_percent** | **float** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement + +role_mining_entitlement = RoleMiningEntitlement( +entitlement_ref=sailpoint.v2024.models.role_mining_entitlement_ref.RoleMiningEntitlementRef( + id = '2c91808a7e95e6e0017e96e2086206c8', + name = 'App.entitlement.1', + description = 'Entitlement 1', + attribute = 'groups', ), +name='Add/modify/delete users', +application_name='AppName', +identity_count=45, +popularity=65.2, +popularity_in_org=35.8, +source_id='2c9180877620c1460176267f336a106f', +activity_source_state='complete', +source_usage_percent=65.6 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..ff8b611d9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningEntitlementRef', 'V2024RoleMiningEntitlementRef'] +slug: /tools/sdk/python/v2024/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'V2024RoleMiningEntitlementRef'] +--- + +# RoleMiningEntitlementRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the entitlement | [optional] +**name** | **str** | Name of the entitlement | [optional] +**description** | **str** | Description forthe entitlement | [optional] +**attribute** | **str** | The entitlement attribute | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_entitlement_ref import RoleMiningEntitlementRef + +role_mining_entitlement_ref = RoleMiningEntitlementRef( +id='2c91808a7e95e6e0017e96e2086206c8', +name='App.entitlement.1', +description='Entitlement 1', +attribute='groups' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..541ef6fca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningIdentity.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningIdentity', 'V2024RoleMiningIdentity'] +slug: /tools/sdk/python/v2024/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'V2024RoleMiningIdentity'] +--- + +# RoleMiningIdentity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the identity | [optional] +**name** | **str** | Name of the identity | [optional] +**attributes** | **map[string]str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_identity import RoleMiningIdentity + +role_mining_identity = RoleMiningIdentity( +id='2c9180877212632a017228d5934525e6', +name='Allene Abernathy-Welch', +attributes={jobTitle=SQL Developer, department=IT, location=NYC, firstName=Allene} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..02f6dc3cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningIdentityDistribution', 'V2024RoleMiningIdentityDistribution'] +slug: /tools/sdk/python/v2024/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'V2024RoleMiningIdentityDistribution'] +--- + +# RoleMiningIdentityDistribution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_name** | **str** | Id of the potential role | [optional] +**distribution** | **[]Dict[str, object]** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_identity_distribution import RoleMiningIdentityDistribution + +role_mining_identity_distribution = RoleMiningIdentityDistribution( +attribute_name='department', +distribution=[{attributeValue=NM Tier 3, count=6}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..3dcbc9bd5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRole.md @@ -0,0 +1,85 @@ +--- +id: v2024-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRole', 'V2024RoleMiningPotentialRole'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'V2024RoleMiningPotentialRole'] +--- + +# RoleMiningPotentialRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_by** | [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**density** | **int** | The density of a potential role. | [optional] +**description** | **str** | The description of a potential role. | [optional] +**entitlement_count** | **int** | The number of entitlements in a potential role. | [optional] +**excluded_entitlements** | **[]str** | The list of entitlement ids to be excluded. | [optional] +**freshness** | **int** | The freshness of a potential role. | [optional] +**identity_count** | **int** | The number of identities in a potential role. | [optional] +**identity_distribution** | [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**identity_ids** | **[]str** | The list of ids in a potential role. | [optional] +**name** | **str** | Name of the potential role. | [optional] +**provision_state** | [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**quality** | **int** | The quality of a potential role. | [optional] +**role_id** | **str** | The roleId of a potential role. | [optional] +**saved** | **bool** | The potential role's saved status. | [optional] +**session** | [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**id** | **str** | Id of the potential role | [optional] +**created_date** | **datetime** | The date-time when this potential role was created. | [optional] +**modified_date** | **datetime** | The date-time when this potential role was modified. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole + +role_mining_potential_role = RoleMiningPotentialRole( +created_by=, +density=75, +description='Potential Role for Accounting dept', +entitlement_count=25, +excluded_entitlements=[07a0b4e2, 13b4e2a0], +freshness=75, +identity_count=25, +identity_distribution=[ + sailpoint.v2024.models.role_mining_identity_distribution.RoleMiningIdentityDistribution( + attribute_name = 'department', + distribution = [{attributeValue=NM Tier 3, count=6}], ) + ], +identity_ids=[07a0b4e2, 13b4e2a0], +name='Saved Potential Role - 07/10', +provision_state=, +quality=100, +role_id='07a0b4e2-7a76-44fa-bd0b-c64654b66519', +saved=True, +session=sailpoint.v2024.models.role_mining_session_parameters_dto.RoleMiningSessionParametersDto( + id = '9f36f5e5-1e81-4eca-b087-548959d91c71', + name = 'Saved RM Session - 07/10', + min_num_identities_in_potential_role = 20, + prune_threshold = 5, + saved = True, + scope = sailpoint.v2024.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), + type = 'SPECIALIZED', + state = 'CREATED', + scoping_method = 'MANUAL', ), +type='SPECIALIZED', +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..730faf9a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleApplication', 'V2024RoleMiningPotentialRoleApplication'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'V2024RoleMiningPotentialRoleApplication'] +--- + +# RoleMiningPotentialRoleApplication + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the application | [optional] +**name** | **str** | Name of the application | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication + +role_mining_potential_role_application = RoleMiningPotentialRoleApplication( +id='{id=2c9180877212632a017228d5a796292b}', +name='{name=Slack}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..ee30f2944 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'V2024RoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'V2024RoleMiningPotentialRoleEditEntitlements'] +--- + +# RoleMiningPotentialRoleEditEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The list of entitlement ids to be edited | [optional] +**exclude** | **bool** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements + +role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements( +ids=[ + '' + ], +exclude=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..1fa516329 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'V2024RoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'V2024RoleMiningPotentialRoleEntitlements'] +--- + +# RoleMiningPotentialRoleEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the entitlement | [optional] +**name** | **str** | Name of the entitlement | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements + +role_mining_potential_role_entitlements = RoleMiningPotentialRoleEntitlements( +id='{id=2c9180877212632a017228d5a796292c}', +name='{name=LauncherTest2}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..afa331772 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'V2024RoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'V2024RoleMiningPotentialRoleExportRequest'] +--- + +# RoleMiningPotentialRoleExportRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min_entitlement_popularity** | **int** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**include_common_access** | **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest + +role_mining_potential_role_export_request = RoleMiningPotentialRoleExportRequest( +min_entitlement_popularity=0, +include_common_access=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..4b8d5a6c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'V2024RoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'V2024RoleMiningPotentialRoleExportResponse'] +--- + +# RoleMiningPotentialRoleExportResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min_entitlement_popularity** | **int** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**include_common_access** | **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**export_id** | **str** | ID used to reference this export | [optional] +**status** | [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse + +role_mining_potential_role_export_response = RoleMiningPotentialRoleExportResponse( +min_entitlement_popularity=0, +include_common_access=True, +export_id='0c6cdb76-1227-4aaf-af21-192dbdfbfa04', +status='QUEUED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..bc0075ecb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,26 @@ +--- +id: v2024-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleExportState', 'V2024RoleMiningPotentialRoleExportState'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'V2024RoleMiningPotentialRoleExportState'] +--- + +# RoleMiningPotentialRoleExportState + + +## Enum + +* `QUEUED` (value: `'QUEUED'`) + +* `IN_PROGRESS` (value: `'IN_PROGRESS'`) + +* `SUCCESS` (value: `'SUCCESS'`) + +* `ERROR` (value: `'ERROR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..f1c0ebb9c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'V2024RoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'V2024RoleMiningPotentialRoleProvisionRequest'] +--- + +# RoleMiningPotentialRoleProvisionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_name** | **str** | Name of the new role being created | [optional] +**role_description** | **str** | Short description of the new role being created | [optional] +**owner_id** | **str** | ID of the identity that will own this role | [optional] +**include_identities** | **bool** | When true, create access requests for the identities associated with the potential role | [optional] [default to False] +**directly_assigned_entitlements** | **bool** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest + +role_mining_potential_role_provision_request = RoleMiningPotentialRoleProvisionRequest( +role_name='Finance - Accounting', +role_description='General access for accounting department', +owner_id='2b568c65bc3c4c57a43bd97e3a8e41', +include_identities=True, +directly_assigned_entitlements=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..f16c97145 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,27 @@ +--- +id: v2024-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'V2024RoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'V2024RoleMiningPotentialRoleProvisionState'] +--- + +# RoleMiningPotentialRoleProvisionState + +Provision state + +## Enum + +* `POTENTIAL` (value: `'POTENTIAL'`) + +* `PENDING` (value: `'PENDING'`) + +* `COMPLETE` (value: `'COMPLETE'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..6fe5e4594 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleRef', 'V2024RoleMiningPotentialRoleRef'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'V2024RoleMiningPotentialRoleRef'] +--- + +# RoleMiningPotentialRoleRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the potential role | [optional] +**name** | **str** | Name of the potential role | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_ref import RoleMiningPotentialRoleRef + +role_mining_potential_role_ref = RoleMiningPotentialRoleRef( +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +name='Potential Role - e0cc5d' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..b36232e95 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'V2024RoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'V2024RoleMiningPotentialRoleSourceUsage'] +--- + +# RoleMiningPotentialRoleSourceUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**display_name** | **str** | Display name for the identity | [optional] +**email** | **str** | Email address for the identity | [optional] +**usage_count** | **int** | The number of days there has been usage of the source by the identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage + +role_mining_potential_role_source_usage = RoleMiningPotentialRoleSourceUsage( +id='2c918089762475180176267f894b54dc', +display_name='Kirk Koepp', +email='kirk.koepp@testmail.identitynow.com', +usage_count=25 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..ca03066f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,79 @@ +--- +id: v2024-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary'] +--- + +# RoleMiningPotentialRoleSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the potential role | [optional] +**name** | **str** | Name of the potential role | [optional] +**potential_role_ref** | [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**identity_count** | **int** | The number of identities in a potential role. | [optional] +**entitlement_count** | **int** | The number of entitlements in a potential role. | [optional] +**identity_group_status** | **str** | The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" | [optional] +**provision_state** | [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**role_id** | **str** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**density** | **int** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**freshness** | **int** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**quality** | **int** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**created_by** | [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**created_date** | **datetime** | The date-time when this potential role was created. | [optional] +**saved** | **bool** | The potential role's saved status | [optional] [default to False] +**description** | **str** | Description of the potential role | [optional] +**session** | [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + +role_mining_potential_role_summary = RoleMiningPotentialRoleSummary( +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +name='Potential Role - e0cc5d', +potential_role_ref=sailpoint.v2024.models.role_mining_potential_role_ref.RoleMiningPotentialRoleRef( + id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', + name = 'Potential Role - e0cc5d', ), +identity_count=25, +entitlement_count=15, +identity_group_status='OBTAINED', +provision_state='POTENTIAL', +role_id='2a4be6fbcf3c4e66b95a0c15ffd591', +density=90, +freshness=70, +quality=80, +type='SPECIALIZED', +created_by=, +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +saved=True, +description='', +session=sailpoint.v2024.models.role_mining_session_parameters_dto.RoleMiningSessionParametersDto( + id = '9f36f5e5-1e81-4eca-b087-548959d91c71', + name = 'Saved RM Session - 07/10', + min_num_identities_in_potential_role = 20, + prune_threshold = 5, + saved = True, + scope = sailpoint.v2024.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), + type = 'SPECIALIZED', + state = 'CREATED', + scoping_method = 'MANUAL', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..77239db00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,36 @@ +--- +id: v2024-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2024RoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/python/v2024/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2024RoleMiningPotentialRoleSummaryCreatedBy'] +--- + +# RoleMiningPotentialRoleSummaryCreatedBy + +The potential role created by details + +## 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.role_mining_potential_role_summary_created_by import RoleMiningPotentialRoleSummaryCreatedBy + +role_mining_potential_role_summary_created_by = RoleMiningPotentialRoleSummaryCreatedBy( +id='2c918090761a5aac0176215c46a62d58', +display_name='Ashley.Pierce' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningRoleType.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..d471bab95 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningRoleType.md @@ -0,0 +1,23 @@ +--- +id: v2024-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningRoleType', 'V2024RoleMiningRoleType'] +slug: /tools/sdk/python/v2024/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'V2024RoleMiningRoleType'] +--- + +# RoleMiningRoleType + +Role type + +## Enum + +* `SPECIALIZED` (value: `'SPECIALIZED'`) + +* `COMMON` (value: `'COMMON'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..9a43b7bb5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionDraftRoleDto', 'V2024RoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/python/v2024/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'V2024RoleMiningSessionDraftRoleDto'] +--- + +# RoleMiningSessionDraftRoleDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the draft role | [optional] +**description** | **str** | Draft role description | [optional] +**identity_ids** | **[]str** | The list of identities for this role mining session. | [optional] +**entitlement_ids** | **[]str** | The list of entitlement ids for this role mining session. | [optional] +**excluded_entitlements** | **[]str** | The list of excluded entitlement ids. | [optional] +**modified** | **datetime** | Last modified date | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**id** | **str** | Id of the potential draft role | [optional] +**created_date** | **datetime** | The date-time when this potential draft role was created. | [optional] +**modified_date** | **datetime** | The date-time when this potential draft role was modified. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto + +role_mining_session_draft_role_dto = RoleMiningSessionDraftRoleDto( +name='Saved RM Session - 07/10', +description='Person who develops software', +identity_ids=[2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], +entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e], +excluded_entitlements=[07a0b4e2, 13b4e2a0], +modified='2020-09-16T18:49:32.150Z', +type='SPECIALIZED', +id='e0cc5d7d-bf7f-4f81-b2af-8885b09d9923', +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..3d3ffe263 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionDto.md @@ -0,0 +1,56 @@ +--- +id: v2024-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionDto', 'V2024RoleMiningSessionDto'] +slug: /tools/sdk/python/v2024/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'V2024RoleMiningSessionDto'] +--- + +# RoleMiningSessionDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**prune_threshold** | **int** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**prescribed_prune_threshold** | **int** | The calculated prescribedPruneThreshold | [optional] +**min_num_identities_in_potential_role** | **int** | Minimum number of identities in a potential role | [optional] +**potential_role_count** | **int** | Number of potential roles | [optional] +**potential_roles_ready_count** | **int** | Number of potential roles ready | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**email_recipient_id** | **str** | The id of the user who will receive an email about the role mining session | [optional] +**identity_count** | **int** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**saved** | **bool** | The session's saved status | [optional] [default to False] +**name** | **str** | The session's saved name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto + +role_mining_session_dto = RoleMiningSessionDto( +scope=sailpoint.v2024.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), +prune_threshold=50, +prescribed_prune_threshold=10, +min_num_identities_in_potential_role=20, +potential_role_count=0, +potential_roles_ready_count=0, +type='SPECIALIZED', +email_recipient_id='2c918090761a5aac0176215c46a62d58', +identity_count=0, +saved=True, +name='Saved RM Session - 07/10' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..43a583003 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,52 @@ +--- +id: v2024-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionParametersDto', 'V2024RoleMiningSessionParametersDto'] +slug: /tools/sdk/python/v2024/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'V2024RoleMiningSessionParametersDto'] +--- + +# RoleMiningSessionParametersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the role mining session | [optional] +**name** | **str** | The session's saved name | [optional] +**min_num_identities_in_potential_role** | **int** | Minimum number of identities in a potential role | [optional] +**prune_threshold** | **int** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**saved** | **bool** | The session's saved status | [optional] [default to True] +**scope** | [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**state** | [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**scoping_method** | [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_session_parameters_dto import RoleMiningSessionParametersDto + +role_mining_session_parameters_dto = RoleMiningSessionParametersDto( +id='9f36f5e5-1e81-4eca-b087-548959d91c71', +name='Saved RM Session - 07/10', +min_num_identities_in_potential_role=20, +prune_threshold=5, +saved=True, +scope=sailpoint.v2024.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), +type='SPECIALIZED', +state='CREATED', +scoping_method='MANUAL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..3cf6627fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionResponse.md @@ -0,0 +1,71 @@ +--- +id: v2024-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionResponse', 'V2024RoleMiningSessionResponse'] +slug: /tools/sdk/python/v2024/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'V2024RoleMiningSessionResponse'] +--- + +# RoleMiningSessionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**min_num_identities_in_potential_role** | **int** | Minimum number of identities in a potential role | [optional] +**scoping_method** | **str** | The scoping method of the role mining session | [optional] +**prescribed_prune_threshold** | **int** | The computed (or prescribed) prune threshold for this session | [optional] +**prune_threshold** | **int** | The prune threshold to be used for this role mining session | [optional] +**potential_role_count** | **int** | The number of potential roles | [optional] +**potential_roles_ready_count** | **int** | The number of potential roles which have completed processing | [optional] +**status** | [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**email_recipient_id** | **str** | The id of the user who will receive an email about the role mining session | [optional] +**created_by** | [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**identity_count** | **int** | The number of identities | [optional] +**saved** | **bool** | The session's saved status | [optional] [default to False] +**name** | **str** | The session's saved name | [optional] +**data_file_path** | **str** | The data file path of the role mining session | [optional] +**id** | **str** | Session Id for this role mining session | [optional] +**created_date** | **datetime** | The date-time when this role mining session was created. | [optional] +**modified_date** | **datetime** | The date-time when this role mining session was completed. | [optional] +**type** | [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessionResponse + +role_mining_session_response = RoleMiningSessionResponse( +scope=sailpoint.v2024.models.role_mining_session_scope.RoleMiningSessionScope( + identity_ids = [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], + criteria = 'source.name:DataScienceDataset', + attribute_filter_criteria = {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}}, ), +min_num_identities_in_potential_role=20, +scoping_method='AUTO_RM', +prescribed_prune_threshold=83, +prune_threshold=70, +potential_role_count=8, +potential_roles_ready_count=4, +status=sailpoint.v2024.models.role_mining_session_status.RoleMiningSessionStatus( + state = 'CREATED', ), +email_recipient_id='', +created_by=, +identity_count=39, +saved=True, +name='Saved RM Session - 07/10', +data_file_path='', +id='8c190e67-87aa-4ed9-a90b-d9d5344523fb', +created_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +modified_date=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +type='SPECIALIZED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..d43675b34 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,36 @@ +--- +id: v2024-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'V2024RoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/python/v2024/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'V2024RoleMiningSessionResponseCreatedBy'] +--- + +# RoleMiningSessionResponseCreatedBy + +The session created by details + +## 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.role_mining_session_response_created_by import RoleMiningSessionResponseCreatedBy + +role_mining_session_response_created_by = RoleMiningSessionResponseCreatedBy( +id='2c918090761a5aac0176215c46a62d58', +display_name='Ashley.Pierce' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionScope.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..5829f59ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionScope.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionScope', 'V2024RoleMiningSessionScope'] +slug: /tools/sdk/python/v2024/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'V2024RoleMiningSessionScope'] +--- + +# RoleMiningSessionScope + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_ids** | **[]str** | The list of identities for this role mining session. | [optional] +**criteria** | **str** | The \"search\" criteria that produces the list of identities for this role mining session. | [optional] +**attribute_filter_criteria** | **[]object** | The filter criteria for this role mining session. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_session_scope import RoleMiningSessionScope + +role_mining_session_scope = RoleMiningSessionScope( +identity_ids=[2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42], +criteria='source.name:DataScienceDataset', +attribute_filter_criteria={displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..b1cfc2432 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,23 @@ +--- +id: v2024-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionScopingMethod', 'V2024RoleMiningSessionScopingMethod'] +slug: /tools/sdk/python/v2024/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'V2024RoleMiningSessionScopingMethod'] +--- + +# RoleMiningSessionScopingMethod + +The scoping method used in the current role mining session. + +## Enum + +* `MANUAL` (value: `'MANUAL'`) + +* `AUTO_RM` (value: `'AUTO_RM'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionState.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..530a434ba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionState.md @@ -0,0 +1,31 @@ +--- +id: v2024-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionState', 'V2024RoleMiningSessionState'] +slug: /tools/sdk/python/v2024/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'V2024RoleMiningSessionState'] +--- + +# RoleMiningSessionState + +Role mining session status + +## Enum + +* `CREATED` (value: `'CREATED'`) + +* `UPDATED` (value: `'UPDATED'`) + +* `IDENTITIES_OBTAINED` (value: `'IDENTITIES_OBTAINED'`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `'PRUNE_THRESHOLD_OBTAINED'`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `'POTENTIAL_ROLES_PROCESSING'`) + +* `POTENTIAL_ROLES_CREATED` (value: `'POTENTIAL_ROLES_CREATED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..29c9e1f91 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleMiningSessionStatus.md @@ -0,0 +1,33 @@ +--- +id: v2024-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMiningSessionStatus', 'V2024RoleMiningSessionStatus'] +slug: /tools/sdk/python/v2024/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'V2024RoleMiningSessionStatus'] +--- + +# RoleMiningSessionStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_mining_session_status import RoleMiningSessionStatus + +role_mining_session_status = RoleMiningSessionStatus( +state='CREATED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleSummary.md new file mode 100644 index 000000000..deda27445 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleSummary.md @@ -0,0 +1,48 @@ +--- +id: v2024-role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleSummary', 'V2024RoleSummary'] +slug: /tools/sdk/python/v2024/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'V2024RoleSummary'] +--- + +# RoleSummary + +Role + +## 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] +**owner** | [**DisplayReference**](display-reference) | | [optional] +**disabled** | **bool** | | [optional] +**revocable** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_summary import RoleSummary + +role_summary = RoleSummary( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ROLE', +owner=, +disabled=True, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RoleTargetDto.md b/docs/tools/sdk/python/Reference/V2024/Models/RoleTargetDto.md new file mode 100644 index 000000000..ff09e16a4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RoleTargetDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleTargetDto', 'V2024RoleTargetDto'] +slug: /tools/sdk/python/v2024/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'V2024RoleTargetDto'] +--- + +# RoleTargetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +**account_info** | [**AccountInfoDto**](account-info-dto) | | [optional] +**role_name** | **str** | Specific role name for this target if using multiple accounts | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.role_target_dto import RoleTargetDto + +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearch.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearch.md new file mode 100644 index 000000000..10ae50171 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearch.md @@ -0,0 +1,63 @@ +--- +id: v2024-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearch', 'V2024SavedSearch'] +slug: /tools/sdk/python/v2024/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2024SavedSearch'] +--- + +# SavedSearch + + +## 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] +**id** | **str** | The saved search ID. | [optional] +**owner** | [**TypedReference**](typed-reference) | | [optional] +**owner_id** | **str** | The ID of the identity that owns this saved search. | [optional] +**public** | **bool** | 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. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search import SavedSearch + +saved_search = SavedSearch( +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=, +id='0de46054-fe90-434a-b84e-c6b3359d0c64', +owner=sailpoint.v2024.models.typed_reference.TypedReference( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', ), +owner_id='2c91808568c529c60168cca6f90c1313', +public=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchComplete.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchComplete.md new file mode 100644 index 000000000..b299470ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchComplete.md @@ -0,0 +1,63 @@ +--- +id: v2024-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchComplete', 'V2024SavedSearchComplete'] +slug: /tools/sdk/python/v2024/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'V2024SavedSearchComplete'] +--- + +# SavedSearchComplete + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_name** | **str** | A name for the report file. | [required] +**owner_email** | **str** | The email address of the identity that owns the saved search. | [required] +**owner_name** | **str** | The name of the identity that owns the saved search. | [required] +**query** | **str** | The search query that was used to generate the report. | [required] +**search_name** | **str** | The name of the saved search. | [required] +**search_results** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**signed_s3_url** | **str** | The Amazon S3 URL to download the report from. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search_complete import SavedSearchComplete + +saved_search_complete = SavedSearchComplete( +file_name='Modified.zip', +owner_email='test@sailpoint.com', +owner_name='Cloud Support', +query='modified:[now-7y/d TO now]', +search_name='Modified Activity', +search_results=sailpoint.v2024.models.saved_search_complete_search_results.SavedSearchComplete_searchResults( + account = sailpoint.v2024.models.saved_search_complete_search_results_account.SavedSearchComplete_searchResults_Account( + count = '3', + noun = 'accounts', + preview = [ + [] + ], ), + entitlement = sailpoint.v2024.models.saved_search_complete_search_results_entitlement.SavedSearchComplete_searchResults_Entitlement( + count = '2', + noun = 'entitlements', + preview = [ + [] + ], ), + identity = sailpoint.v2024.models.saved_search_complete_search_results_identity.SavedSearchComplete_searchResults_Identity( + count = '2', + noun = 'identities', + preview = [ + [] + ], ), ), +signed_s3_url='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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..c98fd1022 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,53 @@ +--- +id: v2024-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResults', 'V2024SavedSearchCompleteSearchResults'] +slug: /tools/sdk/python/v2024/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'V2024SavedSearchCompleteSearchResults'] +--- + +# SavedSearchCompleteSearchResults + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account** | [**SavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**entitlement** | [**SavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**identity** | [**SavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search_complete_search_results import SavedSearchCompleteSearchResults + +saved_search_complete_search_results = SavedSearchCompleteSearchResults( +account=sailpoint.v2024.models.saved_search_complete_search_results_account.SavedSearchComplete_searchResults_Account( + count = '3', + noun = 'accounts', + preview = [ + [] + ], ), +entitlement=sailpoint.v2024.models.saved_search_complete_search_results_entitlement.SavedSearchComplete_searchResults_Entitlement( + count = '2', + noun = 'entitlements', + preview = [ + [] + ], ), +identity=sailpoint.v2024.models.saved_search_complete_search_results_identity.SavedSearchComplete_searchResults_Identity( + count = '2', + noun = 'identities', + preview = [ + [] + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..8954664fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,40 @@ +--- +id: v2024-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'V2024SavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/python/v2024/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'V2024SavedSearchCompleteSearchResultsAccount'] +--- + +# SavedSearchCompleteSearchResultsAccount + +A table of accounts that match the search criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **str** | The number of rows in the table. | [required] +**noun** | **str** | The type of object represented in the table. | [required] +**preview** | **[]List[str]** | A sample of the data in the table. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search_complete_search_results_account import SavedSearchCompleteSearchResultsAccount + +saved_search_complete_search_results_account = SavedSearchCompleteSearchResultsAccount( +count='3', +noun='accounts', +preview=[ + [] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..fd55da3d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,40 @@ +--- +id: v2024-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'V2024SavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/python/v2024/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'V2024SavedSearchCompleteSearchResultsEntitlement'] +--- + +# SavedSearchCompleteSearchResultsEntitlement + +A table of entitlements that match the search criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **str** | The number of rows in the table. | [required] +**noun** | **str** | The type of object represented in the table. | [required] +**preview** | **[]List[str]** | A sample of the data in the table. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search_complete_search_results_entitlement import SavedSearchCompleteSearchResultsEntitlement + +saved_search_complete_search_results_entitlement = SavedSearchCompleteSearchResultsEntitlement( +count='2', +noun='entitlements', +preview=[ + [] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..df5f4ac84 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,40 @@ +--- +id: v2024-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'V2024SavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/python/v2024/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'V2024SavedSearchCompleteSearchResultsIdentity'] +--- + +# SavedSearchCompleteSearchResultsIdentity + +A table of identities that match the search criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **str** | The number of rows in the table. | [required] +**noun** | **str** | The type of object represented in the table. | [required] +**preview** | **[]List[str]** | A sample of the data in the table. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search_complete_search_results_identity import SavedSearchCompleteSearchResultsIdentity + +saved_search_complete_search_results_identity = SavedSearchCompleteSearchResultsIdentity( +count='2', +noun='identities', +preview=[ + [] + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchDetail.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchDetail.md new file mode 100644 index 000000000..a7e2037b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchDetail.md @@ -0,0 +1,49 @@ +--- +id: v2024-saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchDetail', 'V2024SavedSearchDetail'] +slug: /tools/sdk/python/v2024/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'V2024SavedSearchDetail'] +--- + +# SavedSearchDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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.saved_search_detail import SavedSearchDetail + +saved_search_detail = SavedSearchDetail( +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/SavedSearchDetailFilters.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..8ba025071 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchDetailFilters.md @@ -0,0 +1,47 @@ +--- +id: v2024-saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchDetailFilters', 'V2024SavedSearchDetailFilters'] +slug: /tools/sdk/python/v2024/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'V2024SavedSearchDetailFilters'] +--- + +# SavedSearchDetailFilters + + +## 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.saved_search_detail_filters import SavedSearchDetailFilters + +saved_search_detail_filters = SavedSearchDetailFilters( +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/SavedSearchName.md b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchName.md new file mode 100644 index 000000000..09c2789ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SavedSearchName.md @@ -0,0 +1,35 @@ +--- +id: v2024-saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchName', 'V2024SavedSearchName'] +slug: /tools/sdk/python/v2024/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'V2024SavedSearchName'] +--- + +# SavedSearchName + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the saved search. | [optional] +**description** | **str** | The description of the saved search. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.saved_search_name import SavedSearchName + +saved_search_name = SavedSearchName( +name='Disabled accounts', +description='Disabled accounts' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Schedule.md b/docs/tools/sdk/python/Reference/V2024/Models/Schedule.md new file mode 100644 index 000000000..7f9555f7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Schedule.md @@ -0,0 +1,52 @@ +--- +id: v2024-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule', 'V2024Schedule'] +slug: /tools/sdk/python/v2024/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'V2024Schedule'] +--- + +# Schedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WEEKLY', 'MONTHLY', 'ANNUALLY', 'CALENDAR' ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] +**months** | [**ScheduleMonths**](schedule-months) | | [optional] +**days** | [**ScheduleDays**](schedule-days) | | [optional] +**hours** | [**ScheduleHours**](schedule-hours) | | [required] +**expiration** | **datetime** | Specifies the time after which this schedule will no longer occur. | [optional] +**time_zone_id** | **str** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule import Schedule + +schedule = Schedule( +type='WEEKLY', +months=sailpoint.v2024.models.schedule_months.Schedule_months( + type = 'LIST', + values = [1], + interval = 2, ), +days=sailpoint.v2024.models.schedule_days.Schedule_days( + type = 'LIST', + values = [1], + interval = 2, ), +hours=sailpoint.v2024.models.schedule_hours.Schedule_hours( + type = 'LIST', + values = [1], + interval = 2, ), +expiration=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +time_zone_id='CST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Schedule1.md b/docs/tools/sdk/python/Reference/V2024/Models/Schedule1.md new file mode 100644 index 000000000..ddaa14a59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Schedule1.md @@ -0,0 +1,35 @@ +--- +id: v2024-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1', 'V2024Schedule1'] +slug: /tools/sdk/python/v2024/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'V2024Schedule1'] +--- + +# Schedule1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT_AGGREGATION', 'GROUP_AGGREGATION' ] | The type of the Schedule. | [required] +**cron_expression** | **str** | The cron expression of the schedule. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.schedule1 import Schedule1 + +schedule1 = Schedule1( +type='ACCOUNT_AGGREGATION', +cron_expression='0 0 5,13,21 * * ?' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Schedule2.md b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2.md new file mode 100644 index 000000000..a1b309d56 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2.md @@ -0,0 +1,44 @@ +--- +id: v2024-schedule2 +title: Schedule2 +pagination_label: Schedule2 +sidebar_label: Schedule2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule2', 'V2024Schedule2'] +slug: /tools/sdk/python/v2024/models/schedule2 +tags: ['SDK', 'Software Development Kit', 'Schedule2', 'V2024Schedule2'] +--- + +# Schedule2 + +The schedule information. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ScheduleType**](schedule-type) | | [required] +**months** | [**Schedule2Months**](schedule2-months) | | [optional] +**days** | [**Schedule2Days**](schedule2-days) | | [optional] +**hours** | [**Schedule2Hours**](schedule2-hours) | | [required] +**expiration** | **datetime** | A date-time in ISO-8601 format | [optional] +**time_zone_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule2 import Schedule2 + +schedule2 = Schedule2( +type='WEEKLY', +months=, +days=, +hours=, +expiration='2018-06-25T20:22:28.104Z', +time_zone_id='America/Chicago' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Days.md b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Days.md new file mode 100644 index 000000000..c0b5f68a4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Days.md @@ -0,0 +1,38 @@ +--- +id: v2024-schedule2-days +title: Schedule2Days +pagination_label: Schedule2Days +sidebar_label: Schedule2Days +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule2Days', 'V2024Schedule2Days'] +slug: /tools/sdk/python/v2024/models/schedule2-days +tags: ['SDK', 'Software Development Kit', 'Schedule2Days', 'V2024Schedule2Days'] +--- + +# Schedule2Days + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule2_days import Schedule2Days + +schedule2_days = Schedule2Days( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.v2024.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Hours.md b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Hours.md new file mode 100644 index 000000000..d73ad3988 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Hours.md @@ -0,0 +1,38 @@ +--- +id: v2024-schedule2-hours +title: Schedule2Hours +pagination_label: Schedule2Hours +sidebar_label: Schedule2Hours +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule2Hours', 'V2024Schedule2Hours'] +slug: /tools/sdk/python/v2024/models/schedule2-hours +tags: ['SDK', 'Software Development Kit', 'Schedule2Hours', 'V2024Schedule2Hours'] +--- + +# Schedule2Hours + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule2_hours import Schedule2Hours + +schedule2_hours = Schedule2Hours( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.v2024.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Months.md b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Months.md new file mode 100644 index 000000000..b4c22740b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Schedule2Months.md @@ -0,0 +1,38 @@ +--- +id: v2024-schedule2-months +title: Schedule2Months +pagination_label: Schedule2Months +sidebar_label: Schedule2Months +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule2Months', 'V2024Schedule2Months'] +slug: /tools/sdk/python/v2024/models/schedule2-months +tags: ['SDK', 'Software Development Kit', 'Schedule2Months', 'V2024Schedule2Months'] +--- + +# Schedule2Months + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule2_months import Schedule2Months + +schedule2_months = Schedule2Months( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.v2024.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduleDays.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleDays.md new file mode 100644 index 000000000..2be6d8b57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleDays.md @@ -0,0 +1,38 @@ +--- +id: v2024-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleDays', 'V2024ScheduleDays'] +slug: /tools/sdk/python/v2024/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'V2024ScheduleDays'] +--- + +# ScheduleDays + +Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify days value | [required] +**values** | **[]str** | Values of the days based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule_days import ScheduleDays + +schedule_days = ScheduleDays( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduleHours.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleHours.md new file mode 100644 index 000000000..306cbe1f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleHours.md @@ -0,0 +1,38 @@ +--- +id: v2024-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleHours', 'V2024ScheduleHours'] +slug: /tools/sdk/python/v2024/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'V2024ScheduleHours'] +--- + +# ScheduleHours + +Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify hours value | [required] +**values** | **[]str** | Values of the days based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule_hours import ScheduleHours + +schedule_hours = ScheduleHours( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduleMonths.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleMonths.md new file mode 100644 index 000000000..487deec12 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleMonths.md @@ -0,0 +1,38 @@ +--- +id: v2024-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleMonths', 'V2024ScheduleMonths'] +slug: /tools/sdk/python/v2024/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'V2024ScheduleMonths'] +--- + +# ScheduleMonths + +Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify months value | [required] +**values** | **[]str** | Values of the months based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.schedule_months import ScheduleMonths + +schedule_months = ScheduleMonths( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduleType.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleType.md new file mode 100644 index 000000000..221bd43f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduleType.md @@ -0,0 +1,29 @@ +--- +id: v2024-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleType', 'V2024ScheduleType'] +slug: /tools/sdk/python/v2024/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'V2024ScheduleType'] +--- + +# ScheduleType + +Enum representing the currently supported schedule types. Additional values may be added in the future without notice. + +## Enum + +* `DAILY` (value: `'DAILY'`) + +* `WEEKLY` (value: `'WEEKLY'`) + +* `MONTHLY` (value: `'MONTHLY'`) + +* `CALENDAR` (value: `'CALENDAR'`) + +* `ANNUALLY` (value: `'ANNUALLY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledAttributes.md new file mode 100644 index 000000000..895a98281 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledAttributes.md @@ -0,0 +1,42 @@ +--- +id: v2024-scheduled-attributes +title: ScheduledAttributes +pagination_label: ScheduledAttributes +sidebar_label: ScheduledAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledAttributes', 'V2024ScheduledAttributes'] +slug: /tools/sdk/python/v2024/models/scheduled-attributes +tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes', 'V2024ScheduledAttributes'] +--- + +# ScheduledAttributes + +Attributes related to a scheduled trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cron_string** | **str** | A valid CRON expression | [optional] +**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required] +**time_zone** | **str** | Time zone identifier | [optional] +**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional] +**weekly_times** | **[]str** | Scheduled execution times | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.scheduled_attributes import ScheduledAttributes + +scheduled_attributes = ScheduledAttributes( +cron_string='0 9 * * 1', +frequency='daily', +time_zone='America/Chicago', +weekly_days=Monday, +weekly_times=Monday +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearch.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearch.md new file mode 100644 index 000000000..b7056ce08 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearch.md @@ -0,0 +1,69 @@ +--- +id: v2024-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledSearch', 'V2024ScheduledSearch'] +slug: /tools/sdk/python/v2024/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2024ScheduledSearch'] +--- + +# ScheduledSearch + + +## 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] +**id** | **str** | The scheduled search ID. | [required][readonly] +**owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | [required] +**owner_id** | **str** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [required][readonly] +} + +## Example + +```python +from sailpoint.v2024.models.scheduled_search import ScheduledSearch + +scheduled_search = ScheduledSearch( +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, +id='0de46054-fe90-434a-b84e-c6b3359d0c64', +owner=sailpoint.v2024.models.scheduled_search_all_of_owner.ScheduledSearch_allOf_owner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', ), +owner_id='2c9180867624cbd7017642d8c8c81f67' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..d9276cf9d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,36 @@ +--- +id: v2024-scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledSearchAllOfOwner', 'V2024ScheduledSearchAllOfOwner'] +slug: /tools/sdk/python/v2024/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'V2024ScheduledSearchAllOfOwner'] +--- + +# ScheduledSearchAllOfOwner + +The owner of the scheduled search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [required] +**id** | **str** | The ID of the referenced object | [required] +} + +## Example + +```python +from sailpoint.v2024.models.scheduled_search_all_of_owner import ScheduledSearchAllOfOwner + +scheduled_search_all_of_owner = ScheduledSearchAllOfOwner( +type='IDENTITY', +id='2c9180867624cbd7017642d8c8c81f67' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearchName.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearchName.md new file mode 100644 index 000000000..a90e07716 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledSearchName.md @@ -0,0 +1,35 @@ +--- +id: v2024-scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledSearchName', 'V2024ScheduledSearchName'] +slug: /tools/sdk/python/v2024/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'V2024ScheduledSearchName'] +--- + +# ScheduledSearchName + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the scheduled search. | [optional] +**description** | **str** | The description of the scheduled search. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.scheduled_search_name import ScheduledSearchName + +scheduled_search_name = ScheduledSearchName( +name='Daily disabled accounts', +description='Daily disabled accounts' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Scope.md b/docs/tools/sdk/python/Reference/V2024/Models/Scope.md new file mode 100644 index 000000000..0b57b8b5c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Scope.md @@ -0,0 +1,46 @@ +--- +id: v2024-scope +title: Scope +pagination_label: Scope +sidebar_label: Scope +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Scope', 'V2024Scope'] +slug: /tools/sdk/python/v2024/models/scope +tags: ['SDK', 'Software Development Kit', 'Scope', 'V2024Scope'] +--- + +# Scope + +This defines what access the segment is giving + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | [**ScopeType**](scope-type) | | [optional] +**visibility** | [**ScopeVisibilityType**](scope-visibility-type) | | [optional] +**scope_filter** | [**VisibilityCriteria**](visibility-criteria) | | [optional] +**scope_selection** | [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.scope import Scope + +scope = Scope( +scope='ALL', +visibility='ALL', +scope_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 = [], ), ), +scope_selection=[{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScopeType.md b/docs/tools/sdk/python/Reference/V2024/Models/ScopeType.md new file mode 100644 index 000000000..75a9cbdcd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScopeType.md @@ -0,0 +1,27 @@ +--- +id: v2024-scope-type +title: ScopeType +pagination_label: ScopeType +sidebar_label: ScopeType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScopeType', 'V2024ScopeType'] +slug: /tools/sdk/python/v2024/models/scope-type +tags: ['SDK', 'Software Development Kit', 'ScopeType', 'V2024ScopeType'] +--- + +# ScopeType + +An enumeration of the types of scope choices + +## Enum + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +* `CERTIFICATION` (value: `'CERTIFICATION'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +* `ENTITLEMENTREQUEST` (value: `'ENTITLEMENTREQUEST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScopeVisibilityType.md b/docs/tools/sdk/python/Reference/V2024/Models/ScopeVisibilityType.md new file mode 100644 index 000000000..f265a59ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScopeVisibilityType.md @@ -0,0 +1,27 @@ +--- +id: v2024-scope-visibility-type +title: ScopeVisibilityType +pagination_label: ScopeVisibilityType +sidebar_label: ScopeVisibilityType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScopeVisibilityType', 'V2024ScopeVisibilityType'] +slug: /tools/sdk/python/v2024/models/scope-visibility-type +tags: ['SDK', 'Software Development Kit', 'ScopeVisibilityType', 'V2024ScopeVisibilityType'] +--- + +# ScopeVisibilityType + +An enumeration of the types of scope visibility choices + +## Enum + +* `ALL` (value: `'ALL'`) + +* `FILTER` (value: `'FILTER'`) + +* `SELECTION` (value: `'SELECTION'`) + +* `UNSEGMENTED` (value: `'UNSEGMENTED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Search.md b/docs/tools/sdk/python/Reference/V2024/Models/Search.md new file mode 100644 index 000000000..bac5d9884 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Search.md @@ -0,0 +1,82 @@ +--- +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/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] +--- + +# Search + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**query_type** | [**QueryType**](query-type) | | [optional] [default to QueryType.SAILPOINT] +**query_version** | **str** | | [optional] +**query** | [**Query**](query) | | [optional] +**query_dsl** | **object** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**text_query** | [**TextQuery**](text-query) | | [optional] +**type_ahead_query** | [**TypeAheadQuery**](type-ahead-query) | | [optional] +**include_nested** | **bool** | Indicates whether nested objects from returned search results should be included. | [optional] [default to True] +**query_result_filter** | [**QueryResultFilter**](query-result-filter) | | [optional] +**aggregation_type** | [**AggregationType**](aggregation-type) | | [optional] [default to AggregationType.DSL] +**aggregations_version** | **str** | | [optional] +**aggregations_dsl** | **object** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**aggregations** | [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**search_after** | **[]str** | 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\"] | [optional] +**filters** | [**map[string]Filter**](filter) | The filters to be applied for each filtered field name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.search import Search + +search = Search( +indices=[identities], +query_type='SAILPOINT', +query_version=, +query=sailpoint.v2024.models.query.Query( + query = 'name:a*', + fields = '[firstName,lastName,email]', + time_zone = 'America/Chicago', + inner_hit = sailpoint.v2024.models.inner_hit.InnerHit( + query = 'source.name:\"Active Directory\"', + type = 'access', ), ), +query_dsl={match={name=john.doe}}, +text_query=sailpoint.v2024.models.text_query.TextQuery( + terms = [The quick brown fox, 3141592, 7], + fields = [displayName, employeeNumber, roleCount], + match_any = False, + contains = True, ), +type_ahead_query=sailpoint.v2024.models.type_ahead_query.TypeAheadQuery( + query = 'Work', + field = 'source.name', + nested_type = 'access', + max_expansions = 10, + size = 100, + sort = 'desc', + sort_by_value = True, ), +include_nested=True, +query_result_filter=sailpoint.v2024.models.query_result_filter.QueryResultFilter( + includes = [name, displayName], + excludes = [stacktrace], ), +aggregation_type='DSL', +aggregations_version=, +aggregations_dsl={}, +aggregations=, +sort=[displayName, +id], +search_after=[John Doe, 2c91808375d8e80a0175e1f88a575221], +filters={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchAggregationSpecification.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..a32d69937 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchAggregationSpecification.md @@ -0,0 +1,55 @@ +--- +id: v2024-search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchAggregationSpecification', 'V2024SearchAggregationSpecification'] +slug: /tools/sdk/python/v2024/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'V2024SearchAggregationSpecification'] +--- + +# SearchAggregationSpecification + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | [**NestedAggregation**](nested-aggregation) | | [optional] +**metric** | [**MetricAggregation**](metric-aggregation) | | [optional] +**filter** | [**FilterAggregation**](filter-aggregation) | | [optional] +**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional] +**sub_aggregation** | [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.search_aggregation_specification import SearchAggregationSpecification + +search_aggregation_specification = SearchAggregationSpecification( +nested=sailpoint.v2024.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), +metric=sailpoint.v2024.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), +filter=sailpoint.v2024.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + type = 'TERM', + field = 'access.type', + value = 'ENTITLEMENT', ), +bucket=sailpoint.v2024.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + type = 'TERMS', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ), +sub_aggregation= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchArguments.md new file mode 100644 index 000000000..89f27df0a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchArguments.md @@ -0,0 +1,43 @@ +--- +id: v2024-search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchArguments', 'V2024SearchArguments'] +slug: /tools/sdk/python/v2024/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'V2024SearchArguments'] +--- + +# SearchArguments + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schedule_id** | **str** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**owner** | [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**recipients** | [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.search_arguments import SearchArguments + +search_arguments = SearchArguments( +schedule_id='7a724640-0c17-4ce9-a8c3-4a89738459c8', +owner=sailpoint.v2024.models.typed_reference.TypedReference( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', ), +recipients=[ + sailpoint.v2024.models.typed_reference.TypedReference( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchAttributeConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..8f28a6d65 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchAttributeConfig', 'V2024SearchAttributeConfig'] +slug: /tools/sdk/python/v2024/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'V2024SearchAttributeConfig'] +--- + +# SearchAttributeConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the new attribute | [optional] +**display_name** | **str** | The display name of the new attribute | [optional] +**application_attributes** | **object** | Map of application id and their associated attribute. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig + +search_attribute_config = SearchAttributeConfig( +name='newMailAttribute', +display_name='New Mail Attribute', +application_attributes={2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchExportReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..3cd8667d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchExportReportArguments.md @@ -0,0 +1,40 @@ +--- +id: v2024-search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchExportReportArguments', 'V2024SearchExportReportArguments'] +slug: /tools/sdk/python/v2024/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024SearchExportReportArguments'] +--- + +# SearchExportReportArguments + +Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**query** | **str** | 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. | [required] +**columns** | **str** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.search_export_report_arguments import SearchExportReportArguments + +search_export_report_arguments = SearchExportReportArguments( +indices=[entitlements], +query='name:a*', +columns='displayName,firstName,lastName,email,created,attributes.cloudLifecycleState', +sort=[displayName, +id] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchFilterType.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchFilterType.md new file mode 100644 index 000000000..02b0b1856 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchFilterType.md @@ -0,0 +1,21 @@ +--- +id: v2024-search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchFilterType', 'V2024SearchFilterType'] +slug: /tools/sdk/python/v2024/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'V2024SearchFilterType'] +--- + +# SearchFilterType + +Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. + +## Enum + +* `TERM` (value: `'TERM'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..737a93bc5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,44 @@ +--- +id: v2024-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'V2024SearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/python/v2024/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'V2024SearchFormDefinitionsByTenant400Response'] +--- + +# SearchFormDefinitionsByTenant400Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail_code** | **str** | | [optional] +**messages** | [**[]ErrorMessage**](error-message) | | [optional] +**status_code** | **int** | | [optional] +**tracking_id** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.search_form_definitions_by_tenant400_response import SearchFormDefinitionsByTenant400Response + +search_form_definitions_by_tenant400_response = SearchFormDefinitionsByTenant400Response( +detail_code='', +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', ) + ], +status_code=56, +tracking_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SearchSchedule.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchSchedule.md new file mode 100644 index 000000000..534f04737 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchSchedule.md @@ -0,0 +1,57 @@ +--- +id: v2024-search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchSchedule', 'V2024SearchSchedule'] +slug: /tools/sdk/python/v2024/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'V2024SearchSchedule'] +--- + +# SearchSchedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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.search_schedule import SearchSchedule + +search_schedule = SearchSchedule( +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/SearchScheduleRecipientsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..c055e05f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchScheduleRecipientsInner', 'V2024SearchScheduleRecipientsInner'] +slug: /tools/sdk/python/v2024/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'V2024SearchScheduleRecipientsInner'] +--- + +# SearchScheduleRecipientsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [required] +**id** | **str** | The ID of the referenced object | [required] +} + +## Example + +```python +from sailpoint.v2024.models.search_schedule_recipients_inner import SearchScheduleRecipientsInner + +search_schedule_recipients_inner = SearchScheduleRecipientsInner( +type='IDENTITY', +id='2c9180867624cbd7017642d8c8c81f67' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SectionDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/SectionDetails.md new file mode 100644 index 000000000..f363b26f3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SectionDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SectionDetails', 'V2024SectionDetails'] +slug: /tools/sdk/python/v2024/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'V2024SectionDetails'] +--- + +# SectionDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +**label** | **str** | Label of the section | [optional] +**form_items** | **[]object** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.section_details import SectionDetails + +section_details = SectionDetails( +name='Field1', +label='Section 1', +form_items=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Sed.md b/docs/tools/sdk/python/Reference/V2024/Models/Sed.md new file mode 100644 index 000000000..1b79ff4f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Sed.md @@ -0,0 +1,60 @@ +--- +id: v2024-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Sed', 'V2024Sed'] +slug: /tools/sdk/python/v2024/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'V2024Sed'] +--- + +# Sed + +Suggested Entitlement Description + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | name of the entitlement | [optional] +**approved_by** | **str** | entitlement approved by | [optional] +**approved_type** | **str** | entitlement approved type | [optional] +**approved_when** | **datetime** | entitlement approved then | [optional] +**attribute** | **str** | entitlement attribute | [optional] +**description** | **str** | description of entitlement | [optional] +**display_name** | **str** | entitlement display name | [optional] +**id** | **str** | sed id | [optional] +**source_id** | **str** | entitlement source id | [optional] +**source_name** | **str** | entitlement source name | [optional] +**status** | **str** | entitlement status | [optional] +**suggested_description** | **str** | llm suggested entitlement description | [optional] +**type** | **str** | entitlement type | [optional] +**value** | **str** | entitlement value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed import Sed + +sed = Sed( +name='BatchInvoiceProcessing', +approved_by='2c918086-76de-afbf-0176-f6d28f65565a', +approved_type='admin', +approved_when=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +attribute='Role', +description='This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures.', +display_name='AWS-Cloud-Billing', +id='ead281ee-12a9-40ac-9534-36b5d7d65d53', +source_id='103f567b93ee49b991c40f9412f87643', +source_name='IDN Salesforce', +status='suggested', +suggested_description='This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable', +type='group', +value='group' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedApproval.md b/docs/tools/sdk/python/Reference/V2024/Models/SedApproval.md new file mode 100644 index 000000000..471717703 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedApproval.md @@ -0,0 +1,34 @@ +--- +id: v2024-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedApproval', 'V2024SedApproval'] +slug: /tools/sdk/python/v2024/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'V2024SedApproval'] +--- + +# SedApproval + +Sed Approval Request Body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **[]str** | List of SED id's | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_approval import SedApproval + +sed_approval = SedApproval( +items=016629d1-1d25-463f-97f3-c6686846650 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedApprovalStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/SedApprovalStatus.md new file mode 100644 index 000000000..7d2b2361c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedApprovalStatus.md @@ -0,0 +1,38 @@ +--- +id: v2024-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedApprovalStatus', 'V2024SedApprovalStatus'] +slug: /tools/sdk/python/v2024/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'V2024SedApprovalStatus'] +--- + +# SedApprovalStatus + +SED Approval Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**failed_reason** | **str** | failed reason will be display if status is failed | [optional] +**id** | **str** | Sed id | [optional] +**status** | **str** | SUCCESS | FAILED | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_approval_status import SedApprovalStatus + +sed_approval_status = SedApprovalStatus( +failed_reason='invalid status', +id='016629d1-1d25-463f-97f3-0c6686846650', +status='SUCCESS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedAssignee.md b/docs/tools/sdk/python/Reference/V2024/Models/SedAssignee.md new file mode 100644 index 000000000..f73924ba6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedAssignee.md @@ -0,0 +1,36 @@ +--- +id: v2024-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedAssignee', 'V2024SedAssignee'] +slug: /tools/sdk/python/v2024/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'V2024SedAssignee'] +--- + +# SedAssignee + +Sed Assignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GROUP', 'SOURCE_OWNER', 'ENTITLEMENT_OWNER' ] | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | [required] +**value** | **str** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_assignee import SedAssignee + +sed_assignee = SedAssignee( +type='SOURCE_OWNER', +value='016629d1-1d25-463f-97f3-c6686846650' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedAssignment.md b/docs/tools/sdk/python/Reference/V2024/Models/SedAssignment.md new file mode 100644 index 000000000..6e4989209 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedAssignment.md @@ -0,0 +1,40 @@ +--- +id: v2024-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedAssignment', 'V2024SedAssignment'] +slug: /tools/sdk/python/v2024/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'V2024SedAssignment'] +--- + +# SedAssignment + +Sed Assignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignee** | [**SedAssignee**](sed-assignee) | | [optional] +**items** | **[]str** | List of SED id's | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_assignment import SedAssignment + +sed_assignment = SedAssignment( +assignee=sailpoint.v2024.models.sed_assignee.SedAssignee( + type = 'SOURCE_OWNER', + value = '016629d1-1d25-463f-97f3-c6686846650', ), +items=[ + '016629d1-1d25-463f-97f3-0c6686846650' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedAssignmentResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..731b3d31a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedAssignmentResponse.md @@ -0,0 +1,34 @@ +--- +id: v2024-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedAssignmentResponse', 'V2024SedAssignmentResponse'] +slug: /tools/sdk/python/v2024/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'V2024SedAssignmentResponse'] +--- + +# SedAssignmentResponse + +Sed Assignment Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_id** | **str** | BatchId that groups all the ids together | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_assignment_response import SedAssignmentResponse + +sed_assignment_response = SedAssignmentResponse( +batch_id='016629d1-1d25-463f-97f3-0c6686846650' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedBatchRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchRequest.md new file mode 100644 index 000000000..12d56b89f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchRequest.md @@ -0,0 +1,40 @@ +--- +id: v2024-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchRequest', 'V2024SedBatchRequest'] +slug: /tools/sdk/python/v2024/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'V2024SedBatchRequest'] +--- + +# SedBatchRequest + +Sed Batch Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlements** | **[]str** | list of entitlement ids | [optional] +**seds** | **[]str** | list of sed ids | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_batch_request import SedBatchRequest + +sed_batch_request = SedBatchRequest( +entitlements=[ + '016629d1-1d25-463f-97f3-c6686846650' + ], +seds=[ + '016629d1-1d25-463f-97f3-c6686846650' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedBatchResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchResponse.md new file mode 100644 index 000000000..6379572ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchResponse.md @@ -0,0 +1,34 @@ +--- +id: v2024-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchResponse', 'V2024SedBatchResponse'] +slug: /tools/sdk/python/v2024/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'V2024SedBatchResponse'] +--- + +# SedBatchResponse + +Sed Batch Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_id** | **str** | BatchId that groups all the ids together | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_batch_response import SedBatchResponse + +sed_batch_response = SedBatchResponse( +batch_id='016629d1-1d25-463f-97f3-0c6686846650' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedBatchStats.md b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchStats.md new file mode 100644 index 000000000..8ced19457 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchStats.md @@ -0,0 +1,42 @@ +--- +id: v2024-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchStats', 'V2024SedBatchStats'] +slug: /tools/sdk/python/v2024/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'V2024SedBatchStats'] +--- + +# SedBatchStats + +Sed Batch Stats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_complete** | **bool** | batch complete | [optional] [default to False] +**batch_id** | **str** | batch Id | [optional] +**discovered_count** | **int** | discovered count | [optional] +**discovery_complete** | **bool** | discovery complete | [optional] [default to False] +**processed_count** | **int** | processed count | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_batch_stats import SedBatchStats + +sed_batch_stats = SedBatchStats( +batch_complete=True, +batch_id='016629d1-1d25-463f-97f3-0c6686846650', +discovered_count=100, +discovery_complete=True, +processed_count=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedBatchStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchStatus.md new file mode 100644 index 000000000..e4c9b7201 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedBatchStatus.md @@ -0,0 +1,34 @@ +--- +id: v2024-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus'] +slug: /tools/sdk/python/v2024/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus'] +--- + +# SedBatchStatus + +Sed Batch Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | status of batch | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_batch_status import SedBatchStatus + +sed_batch_status = SedBatchStatus( +status='OK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SedPatch.md b/docs/tools/sdk/python/Reference/V2024/Models/SedPatch.md new file mode 100644 index 000000000..b8e77881c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SedPatch.md @@ -0,0 +1,38 @@ +--- +id: v2024-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SedPatch', 'V2024SedPatch'] +slug: /tools/sdk/python/v2024/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'V2024SedPatch'] +--- + +# SedPatch + +Patch for Suggested Entitlement Description + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **str** | desired operation | [optional] +**path** | **str** | field to be patched | [optional] +**value** | **object** | value to replace with | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sed_patch import SedPatch + +sed_patch = SedPatch( +op='replace', +path='status', +value=approved +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Segment.md b/docs/tools/sdk/python/Reference/V2024/Models/Segment.md new file mode 100644 index 000000000..d68a31c12 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Segment.md @@ -0,0 +1,50 @@ +--- +id: v2024-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Segment', 'V2024Segment'] +slug: /tools/sdk/python/v2024/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'V2024Segment'] +--- + +# Segment + + +## 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] +**owner** | [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] +**visibility_criteria** | [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**active** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.segment import Segment + +segment = Segment( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='segment-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This segment represents xyz', +owner=sailpoint.v2024.models.owner_reference_segments.OwnerReferenceSegments( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +visibility_criteria=, +active=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..702824f3e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,38 @@ +--- +id: v2024-segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SegmentVisibilityCriteria', 'V2024SegmentVisibilityCriteria'] +slug: /tools/sdk/python/v2024/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'V2024SegmentVisibilityCriteria'] +--- + +# SegmentVisibilityCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | [**Expression**](expression) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.segment_visibility_criteria import SegmentVisibilityCriteria + +segment_visibility_criteria = SegmentVisibilityCriteria( +expression=sailpoint.v2024.models.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/Selector.md b/docs/tools/sdk/python/Reference/V2024/Models/Selector.md new file mode 100644 index 000000000..5c26c2059 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Selector.md @@ -0,0 +1,38 @@ +--- +id: v2024-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Selector', 'V2024Selector'] +slug: /tools/sdk/python/v2024/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'V2024Selector'] +--- + +# Selector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | The application id | [optional] +**account_match_config** | [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.selector import Selector + +selector = Selector( +application_id='2c91808874ff91550175097daaec161c"', +account_match_config=sailpoint.v2024.models.selector_account_match_config.selector_accountMatchConfig( + match_expression = sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..dd179b415 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelectorAccountMatchConfig', 'V2024SelectorAccountMatchConfig'] +slug: /tools/sdk/python/v2024/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'V2024SelectorAccountMatchConfig'] +--- + +# SelectorAccountMatchConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**match_expression** | [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.selector_account_match_config import SelectorAccountMatchConfig + +selector_account_match_config = SelectorAccountMatchConfig( +match_expression=sailpoint.v2024.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression( + match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], + and = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/python/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..2d61d261b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,35 @@ +--- +id: v2024-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'V2024SelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/python/v2024/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'V2024SelectorAccountMatchConfigMatchExpression'] +--- + +# SelectorAccountMatchConfigMatchExpression + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**match_terms** | [**[]MatchTerm**](match-term) | | [optional] +**var_and** | **bool** | If it is AND operators for match terms | [optional] [default to True] +} + +## Example + +```python +from sailpoint.v2024.models.selector_account_match_config_match_expression import SelectorAccountMatchConfigMatchExpression + +selector_account_match_config_match_expression = SelectorAccountMatchConfigMatchExpression( +match_terms=[{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}], +var_and=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SelfImportExportDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SelfImportExportDto.md new file mode 100644 index 000000000..213514f0a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SelfImportExportDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelfImportExportDto', 'V2024SelfImportExportDto'] +slug: /tools/sdk/python/v2024/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'V2024SelfImportExportDto'] +--- + +# SelfImportExportDto + +Self block for imported/exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **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' ] | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**id** | **str** | Imported/exported object's ID. | [optional] +**name** | **str** | Imported/exported object's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.self_import_export_dto import SelfImportExportDto + +self_import_export_dto = SelfImportExportDto( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..d21611776 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SendAccountVerificationRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendAccountVerificationRequest', 'V2024SendAccountVerificationRequest'] +slug: /tools/sdk/python/v2024/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'V2024SendAccountVerificationRequest'] +--- + +# SendAccountVerificationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_name** | **str** | The source name where identity account password should be reset | [optional] +**via** | **Enum** [ 'EMAIL_WORK', 'EMAIL_PERSONAL', 'LINK_WORK', 'LINK_PERSONAL' ] | The method to send notification | [required] +} + +## Example + +```python +from sailpoint.v2024.models.send_account_verification_request import SendAccountVerificationRequest + +send_account_verification_request = SendAccountVerificationRequest( +source_name='Active Directory Source', +via='EMAIL_WORK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..a741bcc6b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendTestNotificationRequestDto', 'V2024SendTestNotificationRequestDto'] +slug: /tools/sdk/python/v2024/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'V2024SendTestNotificationRequestDto'] +--- + +# SendTestNotificationRequestDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The template notification key. | [optional] +**medium** | **Enum** [ 'EMAIL', 'SLACK', 'TEAMS' ] | The notification medium. Has to be one of the following enum values. | [optional] +**context** | **object** | A Json object that denotes the context specific to the template. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.send_test_notification_request_dto import SendTestNotificationRequestDto + +send_test_notification_request_dto = SendTestNotificationRequestDto( +key='cloud_manual_work_item_summary', +medium='EMAIL', +context=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..45ea58001 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,73 @@ +--- +id: v2024-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationDto', 'V2024ServiceDeskIntegrationDto'] +slug: /tools/sdk/python/v2024/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'V2024ServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the Service Desk integration | [optional] +**name** | **str** | Service Desk integration's name. The name must be unique. | [required] +**created** | **datetime** | The date and time the Service Desk integration was created | [optional] +**modified** | **datetime** | The date and time the Service Desk integration was last modified | [optional] +**description** | **str** | Service Desk integration's description. | [required] +**type** | **str** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to 'ServiceNowSDIM'] +**owner_ref** | [**OwnerDto**](owner-dto) | | [optional] +**cluster_ref** | [**SourceClusterDto**](source-cluster-dto) | | [optional] +**cluster** | **str** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**managed_sources** | **[]str** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**provisioning_config** | [**ProvisioningConfig**](provisioning-config) | | [optional] +**attributes** | **map[string]object** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**before_provisioning_rule** | [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + +service_desk_integration_dto = ServiceDeskIntegrationDto( +id='62945a496ef440189b1f03e3623411c8', +name='Service Desk Integration Name', +created='2024-01-17T18:45:25.994Z', +modified='2024-02-18T18:45:25.994Z', +description='A very nice Service Desk integration', +type='ServiceNowSDIM', +owner_ref=sailpoint.v2024.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +cluster_ref=sailpoint.v2024.models.source_cluster_dto.SourceClusterDto( + type = 'CLUSTER', + id = '2c9180847a7fccdd017aa5896f9f4f6f', + name = 'Training VA', ), +cluster='xyzzy999', +managed_sources=[2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823], +provisioning_config=sailpoint.v2024.models.provisioning_config.ProvisioningConfig( + universal_manager = True, + managed_resource_refs = [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], + plan_initializer_script = sailpoint.v2024.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), + no_provisioning_requests = True, + provisioning_request_expiration = 7, ), +attributes={property=value, key=value}, +before_provisioning_rule=sailpoint.v2024.models.before_provisioning_rule_dto.BeforeProvisioningRuleDto( + type = 'RULE', + id = '048eb3d55c5a4758bd07dccb87741c78', + name = 'Before Provisioning Airtable Rule', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..726990383 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,52 @@ +--- +id: v2024-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'V2024ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/python/v2024/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'V2024ServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**type** | **str** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to 'Web Service SDIM'] +**attributes** | **map[string]object** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] +**provisioning_config** | [**ProvisioningConfig**](provisioning-config) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + +service_desk_integration_template_dto = ServiceDeskIntegrationTemplateDto( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +type='Web Service SDIM', +attributes={property=value, key=value}, +provisioning_config=sailpoint.v2024.models.provisioning_config.ProvisioningConfig( + universal_manager = True, + managed_resource_refs = [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], + plan_initializer_script = sailpoint.v2024.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), + no_provisioning_requests = True, + provisioning_request_expiration = 7, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..333e76d83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,38 @@ +--- +id: v2024-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationTemplateType', 'V2024ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/python/v2024/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'V2024ServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +This represents a Service Desk Integration template type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This is the name of the type. | [optional] +**type** | **str** | This is the type value for the type. | [required] +**script_name** | **str** | This is the scriptName attribute value for the type. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + +service_desk_integration_template_type = ServiceDeskIntegrationTemplateType( +name='aName', +type='aType', +script_name='aScriptName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskSource.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskSource.md new file mode 100644 index 000000000..384190c05 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceDeskSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskSource', 'V2024ServiceDeskSource'] +slug: /tools/sdk/python/v2024/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'V2024ServiceDeskSource'] +--- + +# ServiceDeskSource + +Source for Service Desk integration template. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | DTO type of source for service desk integration template. | [optional] +**id** | **str** | ID of source for service desk integration template. | [optional] +**name** | **str** | Human-readable name of source for service desk integration template. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.service_desk_source import ServiceDeskSource + +service_desk_source = ServiceDeskSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SetIcon200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/SetIcon200Response.md new file mode 100644 index 000000000..dc41dd2b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SetIcon200Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetIcon200Response', 'V2024SetIcon200Response'] +slug: /tools/sdk/python/v2024/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'V2024SetIcon200Response'] +--- + +# SetIcon200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**icon** | **str** | url to file with icon | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.set_icon200_response import SetIcon200Response + +set_icon200_response = SetIcon200Response( +icon='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SetIconRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SetIconRequest.md new file mode 100644 index 000000000..04d95aa41 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SetIconRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetIconRequest', 'V2024SetIconRequest'] +slug: /tools/sdk/python/v2024/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'V2024SetIconRequest'] +--- + +# SetIconRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image** | **bytearray** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | [required] +} + +## Example + +```python +from sailpoint.v2024.models.set_icon_request import SetIconRequest + +set_icon_request = SetIconRequest( +image='\x00\x00\x00\x02' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SetLifecycleState200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..0d5c0af36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SetLifecycleState200Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetLifecycleState200Response', 'V2024SetLifecycleState200Response'] +slug: /tools/sdk/python/v2024/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'V2024SetLifecycleState200Response'] +--- + +# SetLifecycleState200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_activity_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.set_lifecycle_state200_response import SetLifecycleState200Response + +set_lifecycle_state200_response = SetLifecycleState200Response( +account_activity_id='2c9180837ab5b716017ab7c6c9ef1e20' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..6a04f8503 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SetLifecycleStateRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetLifecycleStateRequest', 'V2024SetLifecycleStateRequest'] +slug: /tools/sdk/python/v2024/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'V2024SetLifecycleStateRequest'] +--- + +# SetLifecycleStateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lifecycle_state_id** | **str** | ID of the lifecycle state to set. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.set_lifecycle_state_request import SetLifecycleStateRequest + +set_lifecycle_state_request = SetLifecycleStateRequest( +lifecycle_state_id='2c9180877a86e408017a8c19fefe046c' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SimIntegrationDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..0eba687dd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SimIntegrationDetails.md @@ -0,0 +1,58 @@ +--- +id: v2024-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SimIntegrationDetails', 'V2024SimIntegrationDetails'] +slug: /tools/sdk/python/v2024/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'V2024SimIntegrationDetails'] +--- + +# SimIntegrationDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | The description of the integration | [optional] +**type** | **str** | The integration type | [optional] +**attributes** | **object** | The attributes map containing the credentials used to configure the integration. | [optional] +**sources** | **[]str** | The list of sources (managed resources) | [optional] +**cluster** | **str** | The cluster/proxy | [optional] +**status_map** | **object** | Custom mapping between the integration result and the provisioning result | [optional] +**request** | **object** | Request data to customize desc and body of the created ticket | [optional] +**before_provisioning_rule** | [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + +sim_integration_details = SimIntegrationDetails( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +description='Integration description', +type='ServiceNow Service Desk', +attributes={"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"}, +sources=[2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823], +cluster='xyzzy999', +status_map={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}, +before_provisioning_rule=sailpoint.v2024.models.sim_integration_details_all_of_before_provisioning_rule.SimIntegrationDetails_allOf_beforeProvisioningRule( + type = 'IDENTITY', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/python/Reference/V2024/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..fd970850c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,38 @@ +--- +id: v2024-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2024SimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/python/v2024/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2024SimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +Before provisioning rule of integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | ID of the rule | [optional] +**name** | **str** | Human-readable display name of the rule | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sim_integration_details_all_of_before_provisioning_rule import SimIntegrationDetailsAllOfBeforeProvisioningRule + +sim_integration_details_all_of_before_provisioning_rule = SimIntegrationDetailsAllOfBeforeProvisioningRule( +type='IDENTITY', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SlimCampaign.md b/docs/tools/sdk/python/Reference/V2024/Models/SlimCampaign.md new file mode 100644 index 000000000..0544c163f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SlimCampaign.md @@ -0,0 +1,68 @@ +--- +id: v2024-slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SlimCampaign', 'V2024SlimCampaign'] +slug: /tools/sdk/python/v2024/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'V2024SlimCampaign'] +--- + +# SlimCampaign + + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.slim_campaign import SlimCampaign + +slim_campaign = SlimCampaign( +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.', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/python/Reference/V2024/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..3a66f33a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SlimDiscoveredApplications.md @@ -0,0 +1,50 @@ +--- +id: v2024-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SlimDiscoveredApplications', 'V2024SlimDiscoveredApplications'] +slug: /tools/sdk/python/v2024/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'V2024SlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +Discovered applications + +## 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] +} + +## Example + +```python +from sailpoint.v2024.models.slim_discovered_applications import SlimDiscoveredApplications + +slim_discovered_applications = SlimDiscoveredApplications( +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodExemptCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/SodExemptCriteria.md new file mode 100644 index 000000000..5b3a44707 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodExemptCriteria.md @@ -0,0 +1,40 @@ +--- +id: v2024-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodExemptCriteria', 'V2024SodExemptCriteria'] +slug: /tools/sdk/python/v2024/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'V2024SodExemptCriteria'] +--- + +# SodExemptCriteria + +Details of the Entitlement criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**existing** | **bool** | If the entitlement already belonged to the user or not. | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Entitlement ID | [optional] +**name** | **str** | Entitlement name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_exempt_criteria import SodExemptCriteria + +sod_exempt_criteria = SodExemptCriteria( +existing=True, +type='IDENTITY', +id='2c918085771e9d3301773b3cb66f6398', +name='My HR Entitlement' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodPolicy.md b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicy.md new file mode 100644 index 000000000..7c5f11d4b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicy.md @@ -0,0 +1,75 @@ +--- +id: v2024-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicy', 'V2024SodPolicy'] +slug: /tools/sdk/python/v2024/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'V2024SodPolicy'] +--- + +# SodPolicy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Policy id | [optional] [readonly] +**name** | **str** | Policy Business Name | [optional] +**created** | **datetime** | The time when this SOD policy is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy is modified. | [optional] [readonly] +**description** | **str** | Optional description of the SOD policy | [optional] +**owner_ref** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**external_policy_reference** | **str** | Optional External Policy Reference | [optional] +**policy_query** | **str** | Search query of the SOD policy | [optional] +**compensating_controls** | **str** | Optional compensating controls(Mitigating Controls) | [optional] +**correction_advice** | **str** | Optional correction advice | [optional] +**state** | **Enum** [ 'ENFORCED', 'NOT_ENFORCED' ] | whether the policy is enforced or not | [optional] +**tags** | **[]str** | tags for this policy object | [optional] +**creator_id** | **str** | Policy's creator ID | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID | [optional] [readonly] +**violation_owner_assignment_config** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**scheduled** | **bool** | defines whether a policy has been scheduled or not | [optional] [default to False] +**type** | **Enum** [ 'GENERAL', 'CONFLICTING_ACCESS_BASED' ] | whether a policy is query based or conflicting access based | [optional] [default to 'GENERAL'] +**conflicting_access_criteria** | [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_policy import SodPolicy + +sod_policy = SodPolicy( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='policy-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This policy ensures compliance of xyz', +owner_ref=sailpoint.v2024.models.sod_policy_owner_ref.SodPolicy_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +external_policy_reference='XYZ policy', +policy_query='@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)', +compensating_controls='Have a manager review the transaction decisions for their "out of compliance" employee', +correction_advice='Based on the role of the employee, managers should remove access that is not required for their job function.', +state='ENFORCED', +tags=[TAG1, TAG2], +creator_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +modifier_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +violation_owner_assignment_config=sailpoint.v2024.models.violation_owner_assignment_config.ViolationOwnerAssignmentConfig( + assignment_rule = 'MANAGER', + owner_ref = sailpoint.v2024.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), ), +scheduled=True, +type='GENERAL', +conflicting_access_criteria= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..7d3c24664 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyConflictingAccessCriteria', 'V2024SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/python/v2024/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'V2024SodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +**right_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_policy_conflicting_access_criteria import SodPolicyConflictingAccessCriteria + +sod_policy_conflicting_access_criteria = SodPolicyConflictingAccessCriteria( +left_criteria=sailpoint.v2024.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.v2024.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyDto.md new file mode 100644 index 000000000..e0dc92781 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyDto', 'V2024SodPolicyDto'] +slug: /tools/sdk/python/v2024/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'V2024SodPolicyDto'] +--- + +# SodPolicyDto + +SOD policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOD_POLICY' ] | SOD policy DTO type. | [optional] +**id** | **str** | SOD policy ID. | [optional] +**name** | **str** | SOD policy display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_policy_dto import SodPolicyDto + +sod_policy_dto = SodPolicyDto( +type='SOD_POLICY', +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='Business SOD Policy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..edb87c0d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicyOwnerRef.md @@ -0,0 +1,38 @@ +--- +id: v2024-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyOwnerRef', 'V2024SodPolicyOwnerRef'] +slug: /tools/sdk/python/v2024/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'V2024SodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +The owner of the SOD policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | Owner type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_policy_owner_ref import SodPolicyOwnerRef + +sod_policy_owner_ref = SodPolicyOwnerRef( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodPolicySchedule.md b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicySchedule.md new file mode 100644 index 000000000..51898a866 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodPolicySchedule.md @@ -0,0 +1,60 @@ +--- +id: v2024-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicySchedule', 'V2024SodPolicySchedule'] +slug: /tools/sdk/python/v2024/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'V2024SodPolicySchedule'] +--- + +# SodPolicySchedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | SOD Policy schedule name | [optional] +**created** | **datetime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**description** | **str** | SOD Policy schedule description | [optional] +**schedule** | [**Schedule2**](schedule2) | | [optional] +**recipients** | [**[]SodRecipient**](sod-recipient) | | [optional] +**email_empty_results** | **bool** | Indicates if empty results need to be emailed | [optional] [default to False] +**creator_id** | **str** | Policy's creator ID | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule + +sod_policy_schedule = SodPolicySchedule( +name='SCH-1584312283015', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='Schedule for policy xyz', +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.sod_recipient.SodRecipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ) + ], +email_empty_results=False, +creator_id='0f11f2a47c944bf3a2bd742580fe3bde', +modifier_id='0f11f2a47c944bf3a2bd742580fe3bde' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodRecipient.md b/docs/tools/sdk/python/Reference/V2024/Models/SodRecipient.md new file mode 100644 index 000000000..00dd8f199 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodRecipient.md @@ -0,0 +1,38 @@ +--- +id: v2024-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodRecipient', 'V2024SodRecipient'] +slug: /tools/sdk/python/v2024/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'V2024SodRecipient'] +--- + +# SodRecipient + +SOD policy recipient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | SOD policy recipient DTO type. | [optional] +**id** | **str** | SOD policy recipient's identity ID. | [optional] +**name** | **str** | SOD policy recipient's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_recipient import SodRecipient + +sod_recipient = SodRecipient( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodReportResultDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SodReportResultDto.md new file mode 100644 index 000000000..461ad8cca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodReportResultDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodReportResultDto', 'V2024SodReportResultDto'] +slug: /tools/sdk/python/v2024/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'V2024SodReportResultDto'] +--- + +# SodReportResultDto + +SOD policy violation report result. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_report_result_dto import SodReportResultDto + +sod_report_result_dto = SodReportResultDto( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodViolationCheck.md b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationCheck.md new file mode 100644 index 000000000..83a2adb98 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationCheck.md @@ -0,0 +1,36 @@ +--- +id: v2024-sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationCheck', 'V2024SodViolationCheck'] +slug: /tools/sdk/python/v2024/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'V2024SodViolationCheck'] +--- + +# SodViolationCheck + +An object referencing an SOD violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The id of the original request | [required] +**created** | **datetime** | The date-time when this request was created. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.sod_violation_check import SodViolationCheck + +sod_violation_check = SodViolationCheck( +request_id='089899f13a8f4da7824996191587bab9', +created='2020-01-01T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodViolationCheckResult.md b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..09c69ed27 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationCheckResult.md @@ -0,0 +1,64 @@ +--- +id: v2024-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationCheckResult', 'V2024SodViolationCheckResult'] +slug: /tools/sdk/python/v2024/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'V2024SodViolationCheckResult'] +--- + +# SodViolationCheckResult + +The inner object representing the completed SOD Violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | [**ErrorMessageDto**](error-message-dto) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**violation_contexts** | [**[]SodViolationContext**](sod-violation-context) | | [optional] +**violated_policies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_violation_check_result import SodViolationCheckResult + +sod_violation_check_result = SodViolationCheckResult( +message=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.', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +violation_contexts=[ + sailpoint.v2024.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], +violated_policies=[ + sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContext.md b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContext.md new file mode 100644 index 000000000..6b0a56b9f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContext.md @@ -0,0 +1,48 @@ +--- +id: v2024-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContext', 'V2024SodViolationContext'] +slug: /tools/sdk/python/v2024/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'V2024SodViolationContext'] +--- + +# SodViolationContext + +The contextual information of the violated criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**SodPolicyDto**](sod-policy-dto) | | [optional] +**conflicting_access_criteria** | [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_violation_context import SodViolationContext + +sod_violation_context = SodViolationContext( +policy=sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), +conflicting_access_criteria=sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..caf43d8a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,65 @@ +--- +id: v2024-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextCheckCompleted', 'V2024SodViolationContextCheckCompleted'] +slug: /tools/sdk/python/v2024/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'V2024SodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +An object referencing a completed SOD violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_violation_context_check_completed import SodViolationContextCheckCompleted + +sod_violation_context_check_completed = SodViolationContextCheckCompleted( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.v2024.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v2024.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v2024.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..537eb90f4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,50 @@ +--- +id: v2024-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'V2024SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/python/v2024/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'V2024SodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**right_criteria** | [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria import SodViolationContextConflictingAccessCriteria + +sod_violation_context_conflicting_access_criteria = SodViolationContextConflictingAccessCriteria( +left_criteria=sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), +right_criteria=sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..31b9b4396 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/python/v2024/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteria_list** | [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sod_violation_context_conflicting_access_criteria_left_criteria import SodViolationContextConflictingAccessCriteriaLeftCriteria + +sod_violation_context_conflicting_access_criteria_left_criteria = SodViolationContextConflictingAccessCriteriaLeftCriteria( +criteria_list=[ + sailpoint.v2024.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Source.md b/docs/tools/sdk/python/Reference/V2024/Models/Source.md new file mode 100644 index 000000000..7a5f8b459 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Source.md @@ -0,0 +1,114 @@ +--- +id: v2024-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source', 'V2024Source'] +slug: /tools/sdk/python/v2024/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'V2024Source'] +--- + +# Source + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Source ID. | [optional] [readonly] +**name** | **str** | Source's human-readable name. | [required] +**description** | **str** | Source's human-readable description. | [optional] +**owner** | [**SourceOwner**](source-owner) | | [required] +**cluster** | [**SourceCluster**](source-cluster) | | [optional] +**account_correlation_config** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**account_correlation_rule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**manager_correlation_mapping** | [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**manager_correlation_rule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**before_provisioning_rule** | [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**password_policies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**type** | **str** | 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`. | [optional] +**connector** | **str** | Connector script name. | [required] +**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**connector_attributes** | **object** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False] +**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**since** | **str** | Timestamp that shows when a source health check was last performed. | [optional] +**connector_id** | **str** | Connector ID | [optional] +**connector_name** | **str** | Name of the connector that was chosen during source creation. | [optional] +**connection_type** | **str** | Type of connection (direct or file). | [optional] +**connector_implementation_id** | **str** | Connector implementation ID. | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False] +**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source import Source + +source = Source( +id='2c91808568c529c60168cca6f90c1324', +name='My Source', +description='This is the corporate directory.', +owner=sailpoint.v2024.models.source_owner.Source_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'MyName', ), +cluster=sailpoint.v2024.models.source_cluster.Source_cluster( + type = 'CLUSTER', + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Corporate Cluster', ), +account_correlation_config=sailpoint.v2024.models.source_account_correlation_config.Source_accountCorrelationConfig( + type = 'ACCOUNT_CORRELATION_CONFIG', + id = '2c9180855d191c59015d28583727245a', + name = 'Directory [source-62867] Account Correlation', ), +account_correlation_rule=sailpoint.v2024.models.source_account_correlation_rule.Source_accountCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +manager_correlation_mapping=, +manager_correlation_rule=sailpoint.v2024.models.source_manager_correlation_rule.Source_managerCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +before_provisioning_rule=sailpoint.v2024.models.source_before_provisioning_rule.Source_beforeProvisioningRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}], +password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}], +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +type='OpenLDAP - Direct', +connector='active-directory', +connector_class='sailpoint.connector.LDAPConnector', +connector_attributes={healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]}, +delete_threshold=10, +authoritative=False, +management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup( + type = 'GOVERNANCE_GROUP', + id = '2c91808568c529c60168cca6f90c2222', + name = 'My Management Workgroup', ), +healthy=True, +status='SOURCE_STATE_HEALTHY', +since='2021-09-28T15:48:29.3801666300Z', +connector_id='active-directory', +connector_name='Active Directory', +connection_type='file', +connector_implementation_id='delimited-file', +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z', +credential_provider_enabled=False, +category='CredentialProvider' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Source1.md b/docs/tools/sdk/python/Reference/V2024/Models/Source1.md new file mode 100644 index 000000000..4ad1049f9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Source1.md @@ -0,0 +1,35 @@ +--- +id: v2024-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source1', 'V2024Source1'] +slug: /tools/sdk/python/v2024/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'V2024Source1'] +--- + +# Source1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Attribute mapping type. | [optional] +**properties** | **object** | Attribute mapping properties. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source1 import Source1 + +source1 = Source1( +type='rule', +properties={ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..bf1db5b78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountCorrelationConfig', 'V2024SourceAccountCorrelationConfig'] +slug: /tools/sdk/python/v2024/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'V2024SourceAccountCorrelationConfig'] +--- + +# SourceAccountCorrelationConfig + +Reference to account correlation config object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT_CORRELATION_CONFIG' ] | Type of object being referenced. | [optional] +**id** | **str** | Account correlation config ID. | [optional] +**name** | **str** | Account correlation config's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_correlation_config import SourceAccountCorrelationConfig + +source_account_correlation_config = SourceAccountCorrelationConfig( +type='ACCOUNT_CORRELATION_CONFIG', +id='2c9180855d191c59015d28583727245a', +name='Directory [source-62867] Account Correlation' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..ebfb2bb88 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountCorrelationRule', 'V2024SourceAccountCorrelationRule'] +slug: /tools/sdk/python/v2024/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'V2024SourceAccountCorrelationRule'] +--- + +# SourceAccountCorrelationRule + +Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_correlation_rule import SourceAccountCorrelationRule + +source_account_correlation_rule = SourceAccountCorrelationRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCreated.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCreated.md new file mode 100644 index 000000000..4a965ef2f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountCreated.md @@ -0,0 +1,47 @@ +--- +id: v2024-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountCreated', 'V2024SourceAccountCreated'] +slug: /tools/sdk/python/v2024/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'V2024SourceAccountCreated'] +--- + +# SourceAccountCreated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | SailPoint generated unique identifier. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_created import SourceAccountCreated + +source_account_created = SourceAccountCreated( +uuid='b7264868-7201-415f-9118-b581d431c688', +id='ee769173319b41d19ccec35ba52f237b', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +attributes={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountDeleted.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..62e5e1a7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountDeleted.md @@ -0,0 +1,47 @@ +--- +id: v2024-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountDeleted', 'V2024SourceAccountDeleted'] +slug: /tools/sdk/python/v2024/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'V2024SourceAccountDeleted'] +--- + +# SourceAccountDeleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | SailPoint generated unique identifier. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_deleted import SourceAccountDeleted + +source_account_deleted = SourceAccountDeleted( +uuid='b7264868-7201-415f-9118-b581d431c688', +id='ee769173319b41d19ccec35ba52f237b', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +attributes={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountUpdated.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..37c0687f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountUpdated.md @@ -0,0 +1,47 @@ +--- +id: v2024-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountUpdated', 'V2024SourceAccountUpdated'] +slug: /tools/sdk/python/v2024/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'V2024SourceAccountUpdated'] +--- + +# SourceAccountUpdated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | SailPoint generated unique identifier. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_updated import SourceAccountUpdated + +source_account_updated = SourceAccountUpdated( +uuid='b7264868-7201-415f-9118-b581d431c688', +id='ee769173319b41d19ccec35ba52f237b', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +attributes={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceApp.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceApp.md new file mode 100644 index 000000000..fabb04136 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceApp.md @@ -0,0 +1,63 @@ +--- +id: v2024-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceApp', 'V2024SourceApp'] +slug: /tools/sdk/python/v2024/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'V2024SourceApp'] +--- + +# SourceApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source app id | [optional] +**cloud_app_id** | **str** | The deprecated source app id | [optional] +**name** | **str** | The source app name | [optional] +**created** | **datetime** | Time when the source app was created | [optional] +**modified** | **datetime** | Time when the source app was last modified | [optional] +**enabled** | **bool** | True if the source app is enabled | [optional] [default to False] +**provision_request_enabled** | **bool** | True if the source app is provision request enabled | [optional] [default to False] +**description** | **str** | The description of the source app | [optional] +**match_all_accounts** | **bool** | True if the source app match all accounts | [optional] [default to False] +**app_center_enabled** | **bool** | True if the source app is shown in the app center | [optional] [default to True] +**account_source** | [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**owner** | [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_app import SourceApp + +source_app = SourceApp( +id='2c91808874ff91550175097daaec161c', +cloud_app_id='9854520', +name='my app', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +enabled=True, +provision_request_enabled=True, +description='the source app for engineers', +match_all_accounts=True, +app_center_enabled=True, +account_source=sailpoint.v2024.models.source_app_account_source.SourceApp_accountSource( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', + use_for_password_management = False, + password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ), +owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAppAccountSource.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..1c9880c89 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppAccountSource.md @@ -0,0 +1,41 @@ +--- +id: v2024-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppAccountSource', 'V2024SourceAppAccountSource'] +slug: /tools/sdk/python/v2024/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'V2024SourceAppAccountSource'] +--- + +# SourceAppAccountSource + + +## 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] +**use_for_password_management** | **bool** | If the source is used for password management | [optional] [default to False] +**password_policies** | [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_app_account_source import SourceAppAccountSource + +source_app_account_source = SourceAppAccountSource( +id='2c9180827ca885d7017ca8ce28a000eb', +type='SOURCE', +name='ODS-AD-Source', +use_for_password_management=False, +password_policies=[{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..8e6c3c433 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppBulkUpdateRequest', 'V2024SourceAppBulkUpdateRequest'] +slug: /tools/sdk/python/v2024/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'V2024SourceAppBulkUpdateRequest'] +--- + +# SourceAppBulkUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_ids** | **[]str** | List of source app ids to update | [required] +**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest + +source_app_bulk_update_request = SourceAppBulkUpdateRequest( +app_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f], +json_patch=[{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAppCreateDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..1e37ac1f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppCreateDto.md @@ -0,0 +1,42 @@ +--- +id: v2024-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppCreateDto', 'V2024SourceAppCreateDto'] +slug: /tools/sdk/python/v2024/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'V2024SourceAppCreateDto'] +--- + +# SourceAppCreateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The source app name | [required] +**description** | **str** | The description of the source app | [required] +**match_all_accounts** | **bool** | True if the source app match all accounts | [optional] [default to False] +**account_source** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_app_create_dto import SourceAppCreateDto + +source_app_create_dto = SourceAppCreateDto( +name='my app', +description='the source app for engineers', +match_all_accounts=True, +account_source=sailpoint.v2024.models.source_app_create_dto_account_source.SourceAppCreateDto_accountSource( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..91b4733dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppCreateDtoAccountSource', 'V2024SourceAppCreateDtoAccountSource'] +slug: /tools/sdk/python/v2024/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'V2024SourceAppCreateDtoAccountSource'] +--- + +# SourceAppCreateDtoAccountSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source ID | [required] +**type** | **str** | The source type, will always be \"SOURCE\" | [optional] +**name** | **str** | The source name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_app_create_dto_account_source import SourceAppCreateDtoAccountSource + +source_app_create_dto_account_source = SourceAppCreateDtoAccountSource( +id='2c9180827ca885d7017ca8ce28a000eb', +type='SOURCE', +name='ODS-AD-Source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAppPatchDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..1739a1d2f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAppPatchDto.md @@ -0,0 +1,65 @@ +--- +id: v2024-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAppPatchDto', 'V2024SourceAppPatchDto'] +slug: /tools/sdk/python/v2024/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'V2024SourceAppPatchDto'] +--- + +# SourceAppPatchDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source app id | [optional] +**cloud_app_id** | **str** | The deprecated source app id | [optional] +**name** | **str** | The source app name | [optional] +**created** | **datetime** | Time when the source app was created | [optional] +**modified** | **datetime** | Time when the source app was last modified | [optional] +**enabled** | **bool** | True if the source app is enabled | [optional] [default to False] +**provision_request_enabled** | **bool** | True if the source app is provision request enabled | [optional] [default to False] +**description** | **str** | The description of the source app | [optional] +**match_all_accounts** | **bool** | True if the source app match all accounts | [optional] [default to False] +**app_center_enabled** | **bool** | True if the source app is shown in the app center | [optional] [default to True] +**access_profiles** | **[]str** | List of IDs of access profiles | [optional] +**account_source** | [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**owner** | [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_app_patch_dto import SourceAppPatchDto + +source_app_patch_dto = SourceAppPatchDto( +id='2c91808874ff91550175097daaec161c', +cloud_app_id='9854520', +name='my app', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +enabled=True, +provision_request_enabled=True, +description='the source app for engineers', +match_all_accounts=True, +app_center_enabled=True, +access_profiles=[2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9], +account_source=sailpoint.v2024.models.source_app_account_source.SourceApp_accountSource( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', + use_for_password_management = False, + password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ), +owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..1f1d62a84 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceBeforeProvisioningRule', 'V2024SourceBeforeProvisioningRule'] +slug: /tools/sdk/python/v2024/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'V2024SourceBeforeProvisioningRule'] +--- + +# SourceBeforeProvisioningRule + +Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_before_provisioning_rule import SourceBeforeProvisioningRule + +source_before_provisioning_rule = SourceBeforeProvisioningRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceCluster.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceCluster.md new file mode 100644 index 000000000..5f3ccf8c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceCluster.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCluster', 'V2024SourceCluster'] +slug: /tools/sdk/python/v2024/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'V2024SourceCluster'] +--- + +# SourceCluster + +Reference to the source's associated cluster. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CLUSTER' ] | Type of object being referenced. | [required] +**id** | **str** | Cluster ID. | [required] +**name** | **str** | Cluster's human-readable display name. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_cluster import SourceCluster + +source_cluster = SourceCluster( +type='CLUSTER', +id='2c9180866166b5b0016167c32ef31a66', +name='Corporate Cluster' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceClusterDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceClusterDto.md new file mode 100644 index 000000000..9f6701ae9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceClusterDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceClusterDto', 'V2024SourceClusterDto'] +slug: /tools/sdk/python/v2024/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'V2024SourceClusterDto'] +--- + +# SourceClusterDto + +Source cluster. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CLUSTER' ] | Source cluster DTO type. | [optional] +**id** | **str** | Source cluster ID. | [optional] +**name** | **str** | Source cluster display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_cluster_dto import SourceClusterDto + +source_cluster_dto = SourceClusterDto( +type='CLUSTER', +id='2c9180847a7fccdd017aa5896f9f4f6f', +name='Training VA' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceCode.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceCode.md new file mode 100644 index 000000000..e2abac3e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceCode.md @@ -0,0 +1,36 @@ +--- +id: v2024-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCode', 'V2024SourceCode'] +slug: /tools/sdk/python/v2024/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'V2024SourceCode'] +--- + +# SourceCode + +SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **str** | the version of the code | [required] +**script** | **str** | The code | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_code import SourceCode + +source_code = SourceCode( +version='1.0', +script='return "Mr. " + firstName;' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceCreated.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceCreated.md new file mode 100644 index 000000000..30e34abc7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceCreated.md @@ -0,0 +1,46 @@ +--- +id: v2024-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCreated', 'V2024SourceCreated'] +slug: /tools/sdk/python/v2024/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'V2024SourceCreated'] +--- + +# SourceCreated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the source. | [required] +**name** | **str** | Human friendly name of the source. | [required] +**type** | **str** | The connection type. | [required] +**created** | **datetime** | The date and time the source was created. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceCreatedActor**](source-created-actor) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_created import SourceCreated + +source_created = SourceCreated( +id='2c9180866166b5b0016167c32ef31a66', +name='Test source', +type='DIRECT_CONNECT', +created='2021-03-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.v2024.models.source_created_actor.SourceCreated_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceCreatedActor.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceCreatedActor.md new file mode 100644 index 000000000..e8a304609 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceCreatedActor.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCreatedActor', 'V2024SourceCreatedActor'] +slug: /tools/sdk/python/v2024/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'V2024SourceCreatedActor'] +--- + +# SourceCreatedActor + +Identity who created the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who created the source. | [required] +**id** | **str** | ID of identity who created the source. | [required] +**name** | **str** | Display name of identity who created the source. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_created_actor import SourceCreatedActor + +source_created_actor = SourceCreatedActor( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceDeleted.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceDeleted.md new file mode 100644 index 000000000..89aec10c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceDeleted.md @@ -0,0 +1,46 @@ +--- +id: v2024-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceDeleted', 'V2024SourceDeleted'] +slug: /tools/sdk/python/v2024/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'V2024SourceDeleted'] +--- + +# SourceDeleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the source. | [required] +**name** | **str** | Human friendly name of the source. | [required] +**type** | **str** | The connection type. | [required] +**deleted** | **datetime** | The date and time the source was deleted. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_deleted import SourceDeleted + +source_deleted = SourceDeleted( +id='2c9180866166b5b0016167c32ef31a66', +name='Test source', +type='DIRECT_CONNECT', +deleted='2021-03-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.v2024.models.source_deleted_actor.SourceDeleted_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceDeletedActor.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceDeletedActor.md new file mode 100644 index 000000000..bca3d0ff2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceDeletedActor.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceDeletedActor', 'V2024SourceDeletedActor'] +slug: /tools/sdk/python/v2024/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'V2024SourceDeletedActor'] +--- + +# SourceDeletedActor + +Identity who deleted the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who deleted the source. | [required] +**id** | **str** | ID of identity who deleted the source. | [required] +**name** | **str** | Display name of identity who deleted the source. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_deleted_actor import SourceDeletedActor + +source_deleted_actor = SourceDeletedActor( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..5bf47547c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceEntitlementRequestConfig', 'V2024SourceEntitlementRequestConfig'] +slug: /tools/sdk/python/v2024/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'V2024SourceEntitlementRequestConfig'] +--- + +# SourceEntitlementRequestConfig + +Entitlement Request Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_config** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_entitlement_request_config import SourceEntitlementRequestConfig + +source_entitlement_request_config = SourceEntitlementRequestConfig( +access_request_config=sailpoint.v2024.models.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/SourceHealthDto.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceHealthDto.md new file mode 100644 index 000000000..593094f54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceHealthDto.md @@ -0,0 +1,52 @@ +--- +id: v2024-source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceHealthDto', 'V2024SourceHealthDto'] +slug: /tools/sdk/python/v2024/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'V2024SourceHealthDto'] +--- + +# SourceHealthDto + +Dto for source health data + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of the Source | [optional] [readonly] +**type** | **str** | 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`. | [optional] +**name** | **str** | the name of the source | [optional] +**org** | **str** | source's org | [optional] +**is_authoritative** | **bool** | Is the source authoritative | [optional] +**is_cluster** | **bool** | Is the source in a cluster | [optional] +**hostname** | **str** | source's hostname | [optional] +**pod** | **str** | source's pod | [optional] +**iq_service_version** | **str** | The version of the iqService | [optional] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' ] | connection test result | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_health_dto import SourceHealthDto + +source_health_dto = SourceHealthDto( +id='2c91808568c529c60168cca6f90c1324', +type='OpenLDAP - Direct', +name='Source1234', +org='denali-cjh', +is_authoritative=False, +is_cluster=False, +hostname='megapod-useast1-secret-hostname.sailpoint.com', +pod='megapod-useast1', +iq_service_version='iqVersion123', +status='SOURCE_STATE_UNCHECKED_SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..b4a91358c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceManagementWorkgroup.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceManagementWorkgroup', 'V2024SourceManagementWorkgroup'] +slug: /tools/sdk/python/v2024/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'V2024SourceManagementWorkgroup'] +--- + +# SourceManagementWorkgroup + +Reference to management workgroup for the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP' ] | Type of object being referenced. | [optional] +**id** | **str** | Management workgroup ID. | [optional] +**name** | **str** | Management workgroup's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_management_workgroup import SourceManagementWorkgroup + +source_management_workgroup = SourceManagementWorkgroup( +type='GOVERNANCE_GROUP', +id='2c91808568c529c60168cca6f90c2222', +name='My Management Workgroup' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..a394a3083 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceManagerCorrelationMapping', 'V2024SourceManagerCorrelationMapping'] +slug: /tools/sdk/python/v2024/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'V2024SourceManagerCorrelationMapping'] +--- + +# SourceManagerCorrelationMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_attribute_name** | **str** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**identity_attribute_name** | **str** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_manager_correlation_mapping import SourceManagerCorrelationMapping + +source_manager_correlation_mapping = SourceManagerCorrelationMapping( +account_attribute_name='manager', +identity_attribute_name='manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..8a80b5c00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceManagerCorrelationRule', 'V2024SourceManagerCorrelationRule'] +slug: /tools/sdk/python/v2024/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'V2024SourceManagerCorrelationRule'] +--- + +# SourceManagerCorrelationRule + +Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_manager_correlation_rule import SourceManagerCorrelationRule + +source_manager_correlation_rule = SourceManagerCorrelationRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceOwner.md new file mode 100644 index 000000000..db7a466a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceOwner', 'V2024SourceOwner'] +slug: /tools/sdk/python/v2024/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'V2024SourceOwner'] +--- + +# SourceOwner + +Reference to identity object who owns the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Type of object being referenced. | [optional] +**id** | **str** | Owner identity's ID. | [optional] +**name** | **str** | Owner identity's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_owner import SourceOwner + +source_owner = SourceOwner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='MyName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..5620d9209 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourcePasswordPoliciesInner', 'V2024SourcePasswordPoliciesInner'] +slug: /tools/sdk/python/v2024/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'V2024SourcePasswordPoliciesInner'] +--- + +# SourcePasswordPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'PASSWORD_POLICY' ] | Type of object being referenced. | [optional] +**id** | **str** | Policy ID. | [optional] +**name** | **str** | Policy's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_password_policies_inner import SourcePasswordPoliciesInner + +source_password_policies_inner = SourcePasswordPoliciesInner( +type='PASSWORD_POLICY', +id='2c91808568c529c60168cca6f90c1777', +name='My Password Policy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceSchedule.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceSchedule.md new file mode 100644 index 000000000..3c36ca50b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceSchedule.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-schedule +title: SourceSchedule +pagination_label: SourceSchedule +sidebar_label: SourceSchedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSchedule', 'V2024SourceSchedule'] +slug: /tools/sdk/python/v2024/models/source-schedule +tags: ['SDK', 'Software Development Kit', 'SourceSchedule', 'V2024SourceSchedule'] +--- + +# SourceSchedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT_AGGREGATION', 'GROUP_AGGREGATION' ] | The type of the Schedule. | [required] +**cron_expression** | **str** | The cron expression of the schedule. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_schedule import SourceSchedule + +source_schedule = SourceSchedule( +type='ACCOUNT_AGGREGATION', +cron_expression='0 0 5,13,21 * * ?' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceSchemasInner.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceSchemasInner.md new file mode 100644 index 000000000..55419437a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceSchemasInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSchemasInner', 'V2024SourceSchemasInner'] +slug: /tools/sdk/python/v2024/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'V2024SourceSchemasInner'] +--- + +# SourceSchemasInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | Type of object being referenced. | [optional] +**id** | **str** | Schema ID. | [optional] +**name** | **str** | Schema's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_schemas_inner import SourceSchemasInner + +source_schemas_inner = SourceSchemasInner( +type='CONNECTOR_SCHEMA', +id='2c91808568c529c60168cca6f90c1777', +name='MySchema' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceSyncJob.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceSyncJob.md new file mode 100644 index 000000000..088f5be90 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceSyncJob.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSyncJob', 'V2024SourceSyncJob'] +slug: /tools/sdk/python/v2024/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'V2024SourceSyncJob'] +--- + +# SourceSyncJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Job ID. | [required] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The job status. | [required] +**payload** | [**SourceSyncPayload**](source-sync-payload) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_sync_job import SourceSyncJob + +source_sync_job = SourceSyncJob( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +status='IN_PROGRESS', +payload=sailpoint.v2024.models.source_sync_payload.SourceSyncPayload( + type = 'SYNCHRONIZE_SOURCE_ATTRIBUTES', + data_json = '{"sourceId":"2c918083746f642c01746f990884012a"}', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceSyncPayload.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceSyncPayload.md new file mode 100644 index 000000000..612e9057f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceSyncPayload.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSyncPayload', 'V2024SourceSyncPayload'] +slug: /tools/sdk/python/v2024/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'V2024SourceSyncPayload'] +--- + +# SourceSyncPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Payload type. | [required] +**data_json** | **str** | Payload type. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_sync_payload import SourceSyncPayload + +source_sync_payload = SourceSyncPayload( +type='SYNCHRONIZE_SOURCE_ATTRIBUTES', +data_json='{"sourceId":"2c918083746f642c01746f990884012a"}' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUpdated.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUpdated.md new file mode 100644 index 000000000..a5ce04881 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUpdated.md @@ -0,0 +1,46 @@ +--- +id: v2024-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUpdated', 'V2024SourceUpdated'] +slug: /tools/sdk/python/v2024/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'V2024SourceUpdated'] +--- + +# SourceUpdated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the source. | [required] +**name** | **str** | The user friendly name of the source. | [required] +**type** | **str** | The connection type of the source. | [required] +**modified** | **datetime** | The date and time the source was modified. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_updated import SourceUpdated + +source_updated = SourceUpdated( +id='2c9180866166b5b0016167c32ef31a66', +name='Corporate Active Directory', +type='DIRECT_CONNECT', +modified='2021-03-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.v2024.models.source_updated_actor.SourceUpdated_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUpdatedActor.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..388e2e69e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUpdatedActor.md @@ -0,0 +1,38 @@ +--- +id: v2024-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUpdatedActor', 'V2024SourceUpdatedActor'] +slug: /tools/sdk/python/v2024/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'V2024SourceUpdatedActor'] +--- + +# SourceUpdatedActor + +Identity who updated the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who updated the source. | [required] +**id** | **str** | ID of identity who updated the source. | [optional] +**name** | **str** | Display name of identity who updated the source. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.source_updated_actor import SourceUpdatedActor + +source_updated_actor = SourceUpdatedActor( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md new file mode 100644 index 000000000..ea8523f54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUsage', 'V2024SourceUsage'] +slug: /tools/sdk/python/v2024/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'V2024SourceUsage'] +--- + +# SourceUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional] +**count** | **float** | The average number of days that accounts were active within this source, for the month. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_usage import SourceUsage + +source_usage = SourceUsage( +var_date='Thu Apr 20 20:00:00 EDT 2023', +count=10.45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceUsageStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsageStatus.md new file mode 100644 index 000000000..9f0801fc0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceUsageStatus.md @@ -0,0 +1,33 @@ +--- +id: v2024-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUsageStatus', 'V2024SourceUsageStatus'] +slug: /tools/sdk/python/v2024/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'V2024SourceUsageStatus'] +--- + +# SourceUsageStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'COMPLETE', 'INCOMPLETE' ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_usage_status import SourceUsageStatus + +source_usage_status = SourceUsageStatus( +status='COMPLETE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportJob.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportJob.md new file mode 100644 index 000000000..67f773d7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportJob.md @@ -0,0 +1,45 @@ +--- +id: v2024-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigExportJob', 'V2024SpConfigExportJob'] +slug: /tools/sdk/python/v2024/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'V2024SpConfigExportJob'] +--- + +# SpConfigExportJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +**description** | **str** | Optional user defined description/name for export job. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob + +sp_config_export_job = SpConfigExportJob( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +description='ETS configuration objects from Acme-Solar sandbox' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..20fee5875 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportJobStatus.md @@ -0,0 +1,47 @@ +--- +id: v2024-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigExportJobStatus', 'V2024SpConfigExportJobStatus'] +slug: /tools/sdk/python/v2024/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'V2024SpConfigExportJobStatus'] +--- + +# SpConfigExportJobStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +**description** | **str** | Optional user defined description/name for export job. | [optional] +**completed** | **datetime** | The time the job was completed. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus + +sp_config_export_job_status = SpConfigExportJobStatus( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +description='ETS configuration objects from Acme-Solar sandbox', +completed='2021-05-11T22:23:16Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportResults.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportResults.md new file mode 100644 index 000000000..c3ecb2758 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigExportResults.md @@ -0,0 +1,59 @@ +--- +id: v2024-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigExportResults', 'V2024SpConfigExportResults'] +slug: /tools/sdk/python/v2024/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'V2024SpConfigExportResults'] +--- + +# SpConfigExportResults + +Response model for config export download response. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Current version of the export results object. | [optional] +**timestamp** | **datetime** | Time the export was completed. | [optional] +**tenant** | **str** | Name of the tenant where this export originated. | [optional] +**description** | **str** | Optional user defined description/name for export job. | [optional] +**options** | [**ExportOptions1**](export-options1) | | [optional] +**objects** | [**[]ConfigObject**](config-object) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults + +sp_config_export_results = SpConfigExportResults( +version=1, +timestamp='2021-05-11T22:23:16Z', +tenant='sample-tenant', +description='Export Job 1 Test', +options=sailpoint.v2024.models.export_options_1.ExportOptions_1( + exclude_types = [ + 'SOURCE' + ], + include_types = [ + 'TRIGGER_SUBSCRIPTION' + ], + object_options = {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}, ), +objects=[ + sailpoint.v2024.models.config_object_for_export_and_import.Config Object for Export and Import( + version = 1, + self = sailpoint.v2024.models.self_import_export_dto.SelfImportExportDto( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), + object = { }, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..46d6bef3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigImportJobStatus.md @@ -0,0 +1,47 @@ +--- +id: v2024-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigImportJobStatus', 'V2024SpConfigImportJobStatus'] +slug: /tools/sdk/python/v2024/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'V2024SpConfigImportJobStatus'] +--- + +# SpConfigImportJobStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +**message** | **str** | This message contains additional information about the overall status of the job. | [optional] +**completed** | **datetime** | The time the job was completed. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus + +sp_config_import_job_status = SpConfigImportJobStatus( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +message='Download import results for details.', +completed='2021-05-11T22:23:16Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigImportResults.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigImportResults.md new file mode 100644 index 000000000..9c380d29c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigImportResults.md @@ -0,0 +1,36 @@ +--- +id: v2024-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigImportResults', 'V2024SpConfigImportResults'] +slug: /tools/sdk/python/v2024/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'V2024SpConfigImportResults'] +--- + +# SpConfigImportResults + +Response Body for Config Import command. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**map[string]ObjectImportResult1**](object-import-result1) | The results of an object configuration import job. | [required] +**export_job_id** | **str** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults + +sp_config_import_results = SpConfigImportResults( +results={results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}}, +export_job_id='be9e116d-08e1-49fc-ab7f-fa585e96c9e4' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigJob.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigJob.md new file mode 100644 index 000000000..c9fca450e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigJob.md @@ -0,0 +1,43 @@ +--- +id: v2024-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigJob', 'V2024SpConfigJob'] +slug: /tools/sdk/python/v2024/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'V2024SpConfigJob'] +--- + +# SpConfigJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [required] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [required] +**type** | **Enum** [ 'EXPORT', 'IMPORT' ] | Type of the job, either export or import. | [required] +**expiration** | **datetime** | The time until which the artifacts will be available for download. | [required] +**created** | **datetime** | The time the job was started. | [required] +**modified** | **datetime** | The time of the last update to the job. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_job import SpConfigJob + +sp_config_job = SpConfigJob( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='IMPORT', +expiration='2021-05-11T22:23:16Z', +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigMessage.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigMessage.md new file mode 100644 index 000000000..6ad654167 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigMessage.md @@ -0,0 +1,38 @@ +--- +id: v2024-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigMessage', 'V2024SpConfigMessage'] +slug: /tools/sdk/python/v2024/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'V2024SpConfigMessage'] +--- + +# SpConfigMessage + +Message model for Config Import/Export. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Message key. | [required] +**text** | **str** | Message text. | [required] +**details** | **map[string]object** | Message details if any, in key:value pairs. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_message import SpConfigMessage + +sp_config_message = SpConfigMessage( +key='UNKNOWN_REFERENCE_RESOLVER', +text='Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', +details={details=message details} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigMessage1.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigMessage1.md new file mode 100644 index 000000000..29f9515ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigMessage1.md @@ -0,0 +1,38 @@ +--- +id: v2024-sp-config-message1 +title: SpConfigMessage1 +pagination_label: SpConfigMessage1 +sidebar_label: SpConfigMessage1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigMessage1', 'V2024SpConfigMessage1'] +slug: /tools/sdk/python/v2024/models/sp-config-message1 +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage1', 'V2024SpConfigMessage1'] +--- + +# SpConfigMessage1 + +Message model for Config Import/Export. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Message key. | [required] +**text** | **str** | Message text. | [required] +**details** | **map[string]object** | Message details if any, in key:value pairs. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_message1 import SpConfigMessage1 + +sp_config_message1 = SpConfigMessage1( +key='UNKNOWN_REFERENCE_RESOLVER', +text='Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', +details={details=message details} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md new file mode 100644 index 000000000..6e92048a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md @@ -0,0 +1,60 @@ +--- +id: v2024-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigObject', 'V2024SpConfigObject'] +slug: /tools/sdk/python/v2024/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2024SpConfigObject'] +--- + +# SpConfigObject + +Response model for get object configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_type** | **str** | The object type this configuration is for. | [optional] +**reference_extractors** | **[]str** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] +**signature_required** | **bool** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False] +**always_resolve_by_id** | **bool** | Whether this object type has to be resolved always by ID | [optional] [default to False] +**legacy_object** | **bool** | Whether this is a legacy object | [optional] [default to False] +**one_per_tenant** | **bool** | Whether there is only one object of this type | [optional] [default to False] +**exportable** | **bool** | Whether this object can be exported or it is just a reference object | [optional] [default to False] +**rules** | [**SpConfigRules**](sp-config-rules) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_object import SpConfigObject + +sp_config_object = SpConfigObject( +object_type='TRIGGER_SUBSCRIPTION', +reference_extractors=[$.owner], +signature_required=False, +always_resolve_by_id=True, +legacy_object=False, +one_per_tenant=False, +exportable=True, +rules=sailpoint.v2024.models.config_object_rules.Config Object Rules( + take_from_target_rules = [ + sailpoint.v2024.models.config_object_rule.Config Object Rule( + path = '$.enabled', + value = null, + modes = [RESTORE, PROMOTE], ) + ], + default_rules = [ + sailpoint.v2024.models.config_object_rule.Config Object Rule( + path = '$.enabled', + modes = [RESTORE, PROMOTE], ) + ], + editable = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md new file mode 100644 index 000000000..fb804cd6b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md @@ -0,0 +1,38 @@ +--- +id: v2024-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigRule', 'V2024SpConfigRule'] +slug: /tools/sdk/python/v2024/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] +--- + +# SpConfigRule + +Format of Config Hub Object Rules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] +**value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] +**modes** | **[]str** | Draft modes to which this rule will apply | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_rule import SpConfigRule + +sp_config_rule = SpConfigRule( +path='$.enabled', +value=, +modes=[RESTORE, PROMOTE] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md new file mode 100644 index 000000000..652a35912 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] +slug: /tools/sdk/python/v2024/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] +--- + +# SpConfigRuleValue + +Value to be assigned at the jsonPath location within the object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_rule_value import SpConfigRuleValue + +sp_config_rule_value = SpConfigRuleValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md new file mode 100644 index 000000000..2555fdee0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md @@ -0,0 +1,48 @@ +--- +id: v2024-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigRules', 'V2024SpConfigRules'] +slug: /tools/sdk/python/v2024/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'V2024SpConfigRules'] +--- + +# SpConfigRules + +Rules to be applied to the config object during draft process + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**take_from_target_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] +**default_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] +**editable** | **bool** | Whether this object can be edited | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.sp_config_rules import SpConfigRules + +sp_config_rules = SpConfigRules( +take_from_target_rules=[ + sailpoint.v2024.models.config_object_rule.Config Object Rule( + path = '$.enabled', + value = null, + modes = [RESTORE, PROMOTE], ) + ], +default_rules=[ + sailpoint.v2024.models.config_object_rule.Config Object Rule( + path = '$.enabled', + value = null, + modes = [RESTORE, PROMOTE], ) + ], +editable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/StandardLevel.md b/docs/tools/sdk/python/Reference/V2024/Models/StandardLevel.md new file mode 100644 index 000000000..0563169d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/StandardLevel.md @@ -0,0 +1,33 @@ +--- +id: v2024-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StandardLevel', 'V2024StandardLevel'] +slug: /tools/sdk/python/v2024/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'V2024StandardLevel'] +--- + +# StandardLevel + +Standard Log4j log level + +## Enum + +* `FALSE` (value: `'false'`) + +* `FATAL` (value: `'FATAL'`) + +* `ERROR` (value: `'ERROR'`) + +* `WARN` (value: `'WARN'`) + +* `INFO` (value: `'INFO'`) + +* `DEBUG` (value: `'DEBUG'`) + +* `TRACE` (value: `'TRACE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/StartInvocationInput.md b/docs/tools/sdk/python/Reference/V2024/Models/StartInvocationInput.md new file mode 100644 index 000000000..53b689208 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/StartInvocationInput.md @@ -0,0 +1,37 @@ +--- +id: v2024-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StartInvocationInput', 'V2024StartInvocationInput'] +slug: /tools/sdk/python/v2024/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'V2024StartInvocationInput'] +--- + +# StartInvocationInput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trigger_id** | **str** | Trigger ID | [optional] +**input** | **object** | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**content_json** | **object** | JSON map of invocation metadata | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.start_invocation_input import StartInvocationInput + +start_invocation_input = StartInvocationInput( +trigger_id='idn:access-requested', +input={identityId=201327fda1c44704ac01181e963d463c}, +content_json={workflowId=1234} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/StatusResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/StatusResponse.md new file mode 100644 index 000000000..c60afd1b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/StatusResponse.md @@ -0,0 +1,42 @@ +--- +id: v2024-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StatusResponse', 'V2024StatusResponse'] +slug: /tools/sdk/python/v2024/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'V2024StatusResponse'] +--- + +# StatusResponse + +Response model for connection check, configuration test and ping of source connectors. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the source | [optional] [readonly] +**name** | **str** | Name of the source | [optional] [readonly] +**status** | **Enum** [ 'SUCCESS', 'FAILURE' ] | The status of the health check. | [optional] [readonly] +**elapsed_millis** | **int** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**details** | **object** | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.status_response import StatusResponse + +status_response = StatusResponse( +id='2c91808568c529c60168cca6f90c1313', +name='ODS-AD-Test [source-999999]', +status='SUCCESS', +elapsed_millis=1000, +details={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} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/python/Reference/V2024/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..80d927321 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,71 @@ +--- +id: v2024-sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubSearchAggregationSpecification', 'V2024SubSearchAggregationSpecification'] +slug: /tools/sdk/python/v2024/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'V2024SubSearchAggregationSpecification'] +--- + +# SubSearchAggregationSpecification + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | [**NestedAggregation**](nested-aggregation) | | [optional] +**metric** | [**MetricAggregation**](metric-aggregation) | | [optional] +**filter** | [**FilterAggregation**](filter-aggregation) | | [optional] +**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional] +**sub_aggregation** | [**Aggregations**](aggregations) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sub_search_aggregation_specification import SubSearchAggregationSpecification + +sub_search_aggregation_specification = SubSearchAggregationSpecification( +nested=sailpoint.v2024.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), +metric=sailpoint.v2024.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), +filter=sailpoint.v2024.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + type = 'TERM', + field = 'access.type', + value = 'ENTITLEMENT', ), +bucket=sailpoint.v2024.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + type = 'TERMS', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ), +sub_aggregation=sailpoint.v2024.models.aggregations.Aggregations( + nested = sailpoint.v2024.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), + metric = sailpoint.v2024.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), + filter = sailpoint.v2024.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + field = 'access.type', + value = 'ENTITLEMENT', ), + bucket = sailpoint.v2024.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Subscription.md b/docs/tools/sdk/python/Reference/V2024/Models/Subscription.md new file mode 100644 index 000000000..4c3b8f2cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Subscription.md @@ -0,0 +1,63 @@ +--- +id: v2024-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Subscription', 'V2024Subscription'] +slug: /tools/sdk/python/v2024/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'V2024Subscription'] +--- + +# Subscription + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Subscription ID. | [required] +**name** | **str** | Subscription name. | [required] +**description** | **str** | Subscription description. | [optional] +**trigger_id** | **str** | ID of trigger subscribed to. | [required] +**trigger_name** | **str** | Trigger name of trigger subscribed to. | [required] +**type** | [**SubscriptionType**](subscription-type) | | [required] +**response_deadline** | **str** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to 'PT1H'] +**http_config** | [**HttpConfig**](http-config) | | [optional] +**event_bridge_config** | [**EventBridgeConfig**](event-bridge-config) | | [optional] +**enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [required][default to True] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.subscription import Subscription + +subscription = Subscription( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='Access request subscription', +description='Access requested to site xyz', +trigger_id='idn:access-request-post-approval', +trigger_name='Access Requested', +type='HTTP', +response_deadline='PT1H', +http_config=sailpoint.v2024.models.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 = '', ), ), +event_bridge_config=sailpoint.v2024.models.event_bridge_config.EventBridgeConfig( + aws_account = '123456789012', + aws_region = 'us-west-1', ), +enabled=True, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..0238befca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPatchRequestInner', 'V2024SubscriptionPatchRequestInner'] +slug: /tools/sdk/python/v2024/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'V2024SubscriptionPatchRequestInner'] +--- + +# SubscriptionPatchRequestInner + +A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy' ] | The operation to be performed | [required] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.subscription_patch_request_inner import SubscriptionPatchRequestInner + +subscription_patch_request_inner = SubscriptionPatchRequestInner( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..767df091e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPatchRequestInnerValue', 'V2024SubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/python/v2024/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'V2024SubscriptionPatchRequestInnerValue'] +--- + +# SubscriptionPatchRequestInnerValue + +The value to be used for the operation, required for \"add\" and \"replace\" operations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.subscription_patch_request_inner_value import SubscriptionPatchRequestInnerValue + +subscription_patch_request_inner_value = SubscriptionPatchRequestInnerValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..faa801a28 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,31 @@ +--- +id: v2024-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2024SubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/python/v2024/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2024SubscriptionPatchRequestInnerValueAnyOfInner'] +--- + +# SubscriptionPatchRequestInnerValueAnyOfInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.subscription_patch_request_inner_value_any_of_inner import SubscriptionPatchRequestInnerValueAnyOfInner + +subscription_patch_request_inner_value_any_of_inner = SubscriptionPatchRequestInnerValueAnyOfInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPostRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..d60422e5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPostRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPostRequest', 'V2024SubscriptionPostRequest'] +slug: /tools/sdk/python/v2024/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'V2024SubscriptionPostRequest'] +--- + +# SubscriptionPostRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Subscription name. | [required] +**description** | **str** | Subscription description. | [optional] +**trigger_id** | **str** | ID of trigger subscribed to. | [required] +**type** | [**SubscriptionType**](subscription-type) | | [required] +**response_deadline** | **str** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to 'PT1H'] +**http_config** | [**HttpConfig**](http-config) | | [optional] +**event_bridge_config** | [**EventBridgeConfig**](event-bridge-config) | | [optional] +**enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to True] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.subscription_post_request import SubscriptionPostRequest + +subscription_post_request = SubscriptionPostRequest( +name='Access request subscription', +description='Access requested to site xyz', +trigger_id='idn:access-requested', +type='HTTP', +response_deadline='PT1H', +http_config=sailpoint.v2024.models.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 = '', ), ), +event_bridge_config=sailpoint.v2024.models.event_bridge_config.EventBridgeConfig( + aws_account = '123456789012', + aws_region = 'us-west-1', ), +enabled=True, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPutRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..89f126338 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionPutRequest.md @@ -0,0 +1,57 @@ +--- +id: v2024-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionPutRequest', 'V2024SubscriptionPutRequest'] +slug: /tools/sdk/python/v2024/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'V2024SubscriptionPutRequest'] +--- + +# SubscriptionPutRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Subscription name. | [optional] +**description** | **str** | Subscription description. | [optional] +**type** | [**SubscriptionType**](subscription-type) | | [optional] +**response_deadline** | **str** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to 'PT1H'] +**http_config** | [**HttpConfig**](http-config) | | [optional] +**event_bridge_config** | [**EventBridgeConfig**](event-bridge-config) | | [optional] +**enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to True] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.subscription_put_request import SubscriptionPutRequest + +subscription_put_request = SubscriptionPutRequest( +name='Access request subscription', +description='Access requested to site xyz', +type='HTTP', +response_deadline='PT1H', +http_config=sailpoint.v2024.models.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 = '', ), ), +event_bridge_config=sailpoint.v2024.models.event_bridge_config.EventBridgeConfig( + aws_account = '123456789012', + aws_region = 'us-west-1', ), +enabled=True, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionType.md b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionType.md new file mode 100644 index 000000000..afbce5609 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SubscriptionType.md @@ -0,0 +1,29 @@ +--- +id: v2024-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubscriptionType', 'V2024SubscriptionType'] +slug: /tools/sdk/python/v2024/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'V2024SubscriptionType'] +--- + +# SubscriptionType + +Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. + +## Enum + +* `HTTP` (value: `'HTTP'`) + +* `EVENTBRIDGE` (value: `'EVENTBRIDGE'`) + +* `INLINE` (value: `'INLINE'`) + +* `SCRIPT` (value: `'SCRIPT'`) + +* `WORKFLOW` (value: `'WORKFLOW'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaggedObject.md b/docs/tools/sdk/python/Reference/V2024/Models/TaggedObject.md new file mode 100644 index 000000000..fde5ec76e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaggedObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObject', 'V2024TaggedObject'] +slug: /tools/sdk/python/v2024/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'V2024TaggedObject'] +--- + +# TaggedObject + +Tagged object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_ref** | [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Labels to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tagged_object import TaggedObject + +tagged_object = TaggedObject( +object_ref=sailpoint.v2024.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaggedObjectDto.md b/docs/tools/sdk/python/Reference/V2024/Models/TaggedObjectDto.md new file mode 100644 index 000000000..79ce1f3eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaggedObjectDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObjectDto', 'V2024TaggedObjectDto'] +slug: /tools/sdk/python/v2024/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'V2024TaggedObjectDto'] +--- + +# TaggedObjectDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | DTO type | [optional] +**id** | **str** | ID of the object this reference applies to | [optional] +**name** | **str** | Human-readable display name of the object this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tagged_object_dto import TaggedObjectDto + +tagged_object_dto = TaggedObjectDto( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Target.md b/docs/tools/sdk/python/Reference/V2024/Models/Target.md new file mode 100644 index 000000000..677a68628 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Target.md @@ -0,0 +1,37 @@ +--- +id: v2024-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Target', 'V2024Target'] +slug: /tools/sdk/python/v2024/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'V2024Target'] +--- + +# Target + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Target ID | [optional] +**type** | **Enum** [ 'APPLICATION', 'IDENTITY' ] | Target type | [optional] +**name** | **str** | Target name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.target import Target + +target = Target( +id='c6dc37bf508149b28ce5b7d90ca4bbf9', +type='APPLICATION', +name='Active Directory [source]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskDefinitionSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..65db8ba4a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskDefinitionSummary.md @@ -0,0 +1,44 @@ +--- +id: v2024-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskDefinitionSummary', 'V2024TaskDefinitionSummary'] +slug: /tools/sdk/python/v2024/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'V2024TaskDefinitionSummary'] +--- + +# TaskDefinitionSummary + +Definition of a type of task, used to invoke tasks + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the TaskDefinition | [required] +**unique_name** | **str** | Name of the TaskDefinition | [required] +**description** | **str** | Description of the TaskDefinition | [required] +**parent_name** | **str** | Name of the parent of the TaskDefinition | [required] +**executor** | **str** | Executor of the TaskDefinition | [required] +**arguments** | **map[string]object** | Formal parameters of the TaskDefinition, without values | [required] +} + +## Example + +```python +from sailpoint.v2024.models.task_definition_summary import TaskDefinitionSummary + +task_definition_summary = TaskDefinitionSummary( +id='2c91808475b4334b0175e1dff64b63c5', +unique_name='Cloud Account Aggregation', +description='Aggregates from the specified application.', +parent_name='Cloud Account Aggregation', +executor='sailpoint.task.ServiceTaskExecutor', +arguments={ } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetails.md new file mode 100644 index 000000000..3df701583 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetails.md @@ -0,0 +1,60 @@ +--- +id: v2024-task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDetails', 'V2024TaskResultDetails'] +slug: /tools/sdk/python/v2024/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'V2024TaskResultDetails'] +--- + +# TaskResultDetails + +Details about job or task type, state and lifecycle. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'QUARTZ', 'QPOC', 'MENTOS', 'QUEUED_TASK' ] | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**id** | **str** | Unique task definition identifier. | [optional] +**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional] +**description** | **str** | Description of the report purpose and/or contents. | [optional] +**parent_name** | **str** | Name of the parent task/report if exists. | [optional] +**launcher** | **str** | Name of the report processing initiator. | [optional] +**created** | **datetime** | Report creation date | [optional] +**launched** | **datetime** | Report start date | [optional] +**completed** | **datetime** | Report completion date | [optional] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Report completion status. | [optional] +**messages** | [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**returns** | [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**attributes** | **map[string]object** | Extra attributes map(dictionary) needed for the report. | [optional] +**progress** | **str** | Current report state. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_result_details import TaskResultDetails + +task_result_details = TaskResultDetails( +type='MENTOS', +id='a248c16fe22222b2bd49615481311111', +report_type=IDENTITIES_DETAILS, +description='A detailed view of the identities in the system.', +parent_name='Audit Report', +launcher='cloudadmin', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success', +messages=[], +returns=[], +attributes={org=an-org}, +progress='Initializing...' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..164878a0d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDetailsMessagesInner', 'V2024TaskResultDetailsMessagesInner'] +slug: /tools/sdk/python/v2024/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'V2024TaskResultDetailsMessagesInner'] +--- + +# TaskResultDetailsMessagesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message. | [optional] +**error** | **bool** | Flag whether message is an error. | [optional] [default to False] +**warning** | **bool** | Flag whether message is a warning. | [optional] [default to False] +**key** | **str** | Message string identifier. | [optional] +**localized_text** | **str** | Message context with the locale based language. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_result_details_messages_inner import TaskResultDetailsMessagesInner + +task_result_details_messages_inner = TaskResultDetailsMessagesInner( +type='WARN', +error=False, +warning=True, +key='The following account(s) failed to correlate: A,B,C', +localized_text='The following account(s) failed to correlate: A,B,C' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..1fd1c5d11 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDetailsReturnsInner', 'V2024TaskResultDetailsReturnsInner'] +slug: /tools/sdk/python/v2024/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'V2024TaskResultDetailsReturnsInner'] +--- + +# TaskResultDetailsReturnsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_label** | **str** | Attribute description. | [optional] +**attribute_name** | **str** | System or database attribute name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_result_details_returns_inner import TaskResultDetailsReturnsInner + +task_result_details_returns_inner = TaskResultDetailsReturnsInner( +display_label=' ', +attribute_name=' ' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDto.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDto.md new file mode 100644 index 000000000..7fe5e533d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDto', 'V2024TaskResultDto'] +slug: /tools/sdk/python/v2024/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'V2024TaskResultDto'] +--- + +# TaskResultDto + +Task result. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'TASK_RESULT' ] | Task result DTO type. | [optional] +**id** | **str** | Task result ID. | [optional] +**name** | **str** | Task result display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_result_dto import TaskResultDto + +task_result_dto = TaskResultDto( +type='TASK_RESULT', +id='464ae7bf791e49fdb74606a2e4a89635', +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskResultResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultResponse.md new file mode 100644 index 000000000..d63a6a87a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultResponse', 'V2024TaskResultResponse'] +slug: /tools/sdk/python/v2024/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'V2024TaskResultResponse'] +--- + +# TaskResultResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | the type of response reference | [optional] +**id** | **str** | the task ID | [optional] +**name** | **str** | the task name (not used in this endpoint, always null) | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_result_response import TaskResultResponse + +task_result_response = TaskResultResponse( +type='TASK_RESULT', +id='78733556-9ea3-4f59-bf69-e5cd92b011b4', +name='null' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskResultSimplified.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultSimplified.md new file mode 100644 index 000000000..db393fbfb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskResultSimplified.md @@ -0,0 +1,45 @@ +--- +id: v2024-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultSimplified', 'V2024TaskResultSimplified'] +slug: /tools/sdk/python/v2024/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'V2024TaskResultSimplified'] +--- + +# TaskResultSimplified + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Task identifier | [optional] +**name** | **str** | Task name | [optional] +**description** | **str** | Task description | [optional] +**launcher** | **str** | User or process who launched the task | [optional] +**completed** | **datetime** | Date time of completion | [optional] +**launched** | **datetime** | Date time when the task was launched | [optional] +**completion_status** | **Enum** [ 'Success', 'Warning', 'Error', 'Terminated', 'TempError' ] | Task result status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_result_simplified import TaskResultSimplified + +task_result_simplified = TaskResultSimplified( +id='ff8081814d977c21014da056804a0af3', +name='Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d', +description='Generic task for terminating data in the overlay, used by the TerminationService.', +launcher='support', +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskReturnDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskReturnDetails.md new file mode 100644 index 000000000..bf14bc594 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskReturnDetails.md @@ -0,0 +1,36 @@ +--- +id: v2024-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskReturnDetails', 'V2024TaskReturnDetails'] +slug: /tools/sdk/python/v2024/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'V2024TaskReturnDetails'] +--- + +# TaskReturnDetails + +Task return details + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Display name of the TaskReturnDetails | [required] +**attribute_name** | **str** | Attribute the TaskReturnDetails is for | [required] +} + +## Example + +```python +from sailpoint.v2024.models.task_return_details import TaskReturnDetails + +task_return_details = TaskReturnDetails( +name='label', +attribute_name='identityCount' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskStatus.md new file mode 100644 index 000000000..0397c98a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskStatus.md @@ -0,0 +1,89 @@ +--- +id: v2024-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskStatus', 'V2024TaskStatus'] +slug: /tools/sdk/python/v2024/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'V2024TaskStatus'] +--- + +# TaskStatus + +Details and current status of a specific task + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the task this TaskStatus represents | [required] +**type** | **Enum** [ 'QUARTZ', 'QPOC', 'QUEUED_TASK' ] | Type of task this TaskStatus represents | [required] +**unique_name** | **str** | Name of the task this TaskStatus represents | [required] +**description** | **str** | Description of the task this TaskStatus represents | [required] +**parent_name** | **str** | Name of the parent of the task this TaskStatus represents | [required] +**launcher** | **str** | Service to execute the task this TaskStatus represents | [required] +**target** | [**Target**](target) | | [optional] +**created** | **datetime** | Creation date of the task this TaskStatus represents | [required] +**modified** | **datetime** | Last modification date of the task this TaskStatus represents | [required] +**launched** | **datetime** | Launch date of the task this TaskStatus represents | [required] +**completed** | **datetime** | Completion date of the task this TaskStatus represents | [required] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMPERROR' ] | Completion status of the task this TaskStatus represents | [required] +**messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | [required] +**returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | [required] +**attributes** | **map[string]object** | Attributes of the task this TaskStatus represents | [required] +**progress** | **str** | Current progress of the task this TaskStatus represents | [required] +**percent_complete** | **int** | Current percentage completion of the task this TaskStatus represents | [required] +**task_definition_summary** | [**TaskDefinitionSummary**](task-definition-summary) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.task_status import TaskStatus + +task_status = TaskStatus( +id='id12345', +type='QUARTZ', +unique_name='Big Task', +description='A Really Big Task', +parent_name='Parent Task', +launcher='sweep', +target=sailpoint.v2024.models.target.Target( + id = 'c6dc37bf508149b28ce5b7d90ca4bbf9', + type = 'APPLICATION', + name = 'Active Directory [source]', ), +created='2020-07-11T21:23:15Z', +modified='2020-07-11T21:23:15Z', +launched='2020-07-11T21:23:15Z', +completed='2020-07-11T21:23:15Z', +completion_status='SUCCESS', +messages=[ + sailpoint.v2024.models.task_status_message.TaskStatusMessage( + type = 'INFO', + localized_text = sailpoint.v2024.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), + key = 'akey', + parameters = [{name=value}], ) + ], +returns=[ + sailpoint.v2024.models.task_return_details.TaskReturnDetails( + name = 'label', + attribute_name = 'identityCount', ) + ], +attributes={identityCount=0}, +progress='Started', +percent_complete=100, +task_definition_summary=sailpoint.v2024.models.task_definition_summary.TaskDefinitionSummary( + id = '2c91808475b4334b0175e1dff64b63c5', + unique_name = 'Cloud Account Aggregation', + description = 'Aggregates from the specified application.', + parent_name = 'Cloud Account Aggregation', + executor = 'sailpoint.task.ServiceTaskExecutor', + arguments = { }, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskStatusMessage.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskStatusMessage.md new file mode 100644 index 000000000..ae6cbbe0f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskStatusMessage.md @@ -0,0 +1,42 @@ +--- +id: v2024-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskStatusMessage', 'V2024TaskStatusMessage'] +slug: /tools/sdk/python/v2024/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'V2024TaskStatusMessage'] +--- + +# TaskStatusMessage + +TaskStatus Message + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message | [required] +**localized_text** | [**LocalizedMessage**](localized-message) | | [required] +**key** | **str** | Key of the message | [required] +**parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | [required] +} + +## Example + +```python +from sailpoint.v2024.models.task_status_message import TaskStatusMessage + +task_status_message = TaskStatusMessage( +type='INFO', +localized_text=sailpoint.v2024.models.localized_message.LocalizedMessage( + locale = 'An error has occurred!', + message = 'Error has occurred!', ), +key='akey', +parameters=[{name=value}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/python/Reference/V2024/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..ddf40e560 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,31 @@ +--- +id: v2024-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskStatusMessageParametersInner', 'V2024TaskStatusMessageParametersInner'] +slug: /tools/sdk/python/v2024/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'V2024TaskStatusMessageParametersInner'] +--- + +# TaskStatusMessageParametersInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.task_status_message_parameters_inner import TaskStatusMessageParametersInner + +task_status_message_parameters_inner = TaskStatusMessageParametersInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..872ddaa97 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateBulkDeleteDto', 'V2024TemplateBulkDeleteDto'] +slug: /tools/sdk/python/v2024/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'V2024TemplateBulkDeleteDto'] +--- + +# TemplateBulkDeleteDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [required] +**medium** | **Enum** [ 'EMAIL', 'PHONE', 'SMS' ] | | [optional] +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_bulk_delete_dto import TemplateBulkDeleteDto + +template_bulk_delete_dto = TemplateBulkDeleteDto( +key='cloud_manual_work_item_summary', +medium='EMAIL', +locale='en' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateDto.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateDto.md new file mode 100644 index 000000000..01b9fec85 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateDto.md @@ -0,0 +1,63 @@ +--- +id: v2024-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateDto', 'V2024TemplateDto'] +slug: /tools/sdk/python/v2024/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'V2024TemplateDto'] +--- + +# TemplateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the template | [required] +**name** | **str** | The name of the Task Manager Subscription | [optional] +**medium** | **Enum** [ 'EMAIL', 'PHONE', 'SMS', 'SLACK', 'TEAMS' ] | The message medium. More mediums may be added in the future. | [required] +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [required] +**subject** | **str** | The subject line in the template | [optional] +**header** | **str** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**body** | **str** | The body in the template | [optional] +**footer** | **str** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**var_from** | **str** | The \"From:\" address in the template | [optional] +**reply_to** | **str** | The \"Reply To\" line in the template | [optional] +**description** | **str** | The description in the template | [optional] +**id** | **str** | This is auto-generated. | [optional] +**created** | **datetime** | The time when this template is created. This is auto-generated. | [optional] +**modified** | **datetime** | The time when this template was last modified. This is auto-generated. | [optional] +**slack_template** | **str** | | [optional] +**teams_template** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_dto import TemplateDto + +template_dto = TemplateDto( +key='cloud_manual_work_item_summary', +name='Task Manager Subscription', +medium='EMAIL', +locale='en', +subject='You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.', +header='', +body='Please go to the task manager', +footer='', +var_from='$__global.emailFromAddress', +reply_to='$__global.emailFromAddress', +description='Daily digest - sent if number of outstanding tasks for task owner > 0', +id='c17bea3a-574d-453c-9e04-4365fbf5af0b', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +slack_template='', +teams_template='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateDtoDefault.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..191319a07 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateDtoDefault.md @@ -0,0 +1,97 @@ +--- +id: v2024-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateDtoDefault', 'V2024TemplateDtoDefault'] +slug: /tools/sdk/python/v2024/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'V2024TemplateDtoDefault'] +--- + +# TemplateDtoDefault + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the default template | [optional] +**name** | **str** | The name of the default template | [optional] +**medium** | **Enum** [ 'EMAIL', 'PHONE', 'SMS', 'SLACK', 'TEAMS' ] | The message medium. More mediums may be added in the future. | [optional] +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional] +**subject** | **str** | The subject of the default template | [optional] +**header** | **str** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**body** | **str** | The body of the default template | [optional] +**footer** | **str** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**var_from** | **str** | The \"From:\" address of the default template | [optional] +**reply_to** | **str** | The \"Reply To\" field of the default template | [optional] +**description** | **str** | The description of the default template | [optional] +**slack_template** | [**TemplateSlack**](template-slack) | | [optional] +**teams_template** | [**TemplateTeams**](template-teams) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_dto_default import TemplateDtoDefault + +template_dto_default = TemplateDtoDefault( +key='cloud_manual_work_item_summary', +name='Task Manager Subscription', +medium='EMAIL', +locale='en', +subject='You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.', +header='', +body='Please go to the task manager', +footer='', +var_from='$__global.emailFromAddress', +reply_to='$__global.emailFromAddress', +description='Daily digest - sent if number of outstanding tasks for task owner > 0', +slack_template=sailpoint.v2024.models.template_slack.TemplateSlack( + key = '', + text = '', + blocks = '', + attachments = '', + notification_type = '', + approval_id = '', + request_id = '', + requested_by_id = '', + is_subscription = True, + auto_approval_data = sailpoint.v2024.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), + custom_fields = sailpoint.v2024.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ), ), +teams_template=sailpoint.v2024.models.template_teams.TemplateTeams( + key = '', + title = '', + text = '', + message_json = '', + is_subscription = True, + approval_id = '', + request_id = '', + requested_by_id = '', + notification_type = '', + auto_approval_data = sailpoint.v2024.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), + custom_fields = sailpoint.v2024.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlack.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlack.md new file mode 100644 index 000000000..758c90359 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlack.md @@ -0,0 +1,62 @@ +--- +id: v2024-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateSlack', 'V2024TemplateSlack'] +slug: /tools/sdk/python/v2024/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'V2024TemplateSlack'] +--- + +# TemplateSlack + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [optional] +**text** | **str** | | [optional] +**blocks** | **str** | | [optional] +**attachments** | **str** | | [optional] +**notification_type** | **str** | | [optional] +**approval_id** | **str** | | [optional] +**request_id** | **str** | | [optional] +**requested_by_id** | **str** | | [optional] +**is_subscription** | **bool** | | [optional] +**auto_approval_data** | [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**custom_fields** | [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_slack import TemplateSlack + +template_slack = TemplateSlack( +key='', +text='', +blocks='', +attachments='', +notification_type='', +approval_id='', +request_id='', +requested_by_id='', +is_subscription=True, +auto_approval_data=sailpoint.v2024.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), +custom_fields=sailpoint.v2024.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..b0620f780 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,41 @@ +--- +id: v2024-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateSlackAutoApprovalData', 'V2024TemplateSlackAutoApprovalData'] +slug: /tools/sdk/python/v2024/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'V2024TemplateSlackAutoApprovalData'] +--- + +# TemplateSlackAutoApprovalData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**is_auto_approved** | **str** | | [optional] +**item_id** | **str** | | [optional] +**item_type** | **str** | | [optional] +**auto_approval_message_json** | **str** | | [optional] +**auto_approval_title** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_slack_auto_approval_data import TemplateSlackAutoApprovalData + +template_slack_auto_approval_data = TemplateSlackAutoApprovalData( +is_auto_approved='', +item_id='', +item_type='', +auto_approval_message_json='', +auto_approval_title='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..cae22f56e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateSlackCustomFields.md @@ -0,0 +1,39 @@ +--- +id: v2024-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateSlackCustomFields', 'V2024TemplateSlackCustomFields'] +slug: /tools/sdk/python/v2024/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'V2024TemplateSlackCustomFields'] +--- + +# TemplateSlackCustomFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_type** | **str** | | [optional] +**contains_deny** | **str** | | [optional] +**campaign_id** | **str** | | [optional] +**campaign_status** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_slack_custom_fields import TemplateSlackCustomFields + +template_slack_custom_fields = TemplateSlackCustomFields( +request_type='', +contains_deny='', +campaign_id='', +campaign_status='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TemplateTeams.md b/docs/tools/sdk/python/Reference/V2024/Models/TemplateTeams.md new file mode 100644 index 000000000..6823812a2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TemplateTeams.md @@ -0,0 +1,62 @@ +--- +id: v2024-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TemplateTeams', 'V2024TemplateTeams'] +slug: /tools/sdk/python/v2024/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'V2024TemplateTeams'] +--- + +# TemplateTeams + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [optional] +**title** | **str** | | [optional] +**text** | **str** | | [optional] +**message_json** | **str** | | [optional] +**is_subscription** | **bool** | | [optional] +**approval_id** | **str** | | [optional] +**request_id** | **str** | | [optional] +**requested_by_id** | **str** | | [optional] +**notification_type** | **str** | | [optional] +**auto_approval_data** | [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**custom_fields** | [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.template_teams import TemplateTeams + +template_teams = TemplateTeams( +key='', +title='', +text='', +message_json='', +is_subscription=True, +approval_id='', +request_id='', +requested_by_id='', +notification_type='', +auto_approval_data=sailpoint.v2024.models.template_slack_auto_approval_data.TemplateSlack_autoApprovalData( + is_auto_approved = '', + item_id = '', + item_type = '', + auto_approval_message_json = '', + auto_approval_title = '', ), +custom_fields=sailpoint.v2024.models.template_slack_custom_fields.TemplateSlack_customFields( + request_type = '', + contains_deny = '', + campaign_id = '', + campaign_status = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Tenant.md b/docs/tools/sdk/python/Reference/V2024/Models/Tenant.md new file mode 100644 index 000000000..9ccc804ec --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Tenant.md @@ -0,0 +1,67 @@ +--- +id: v2024-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tenant', 'V2024Tenant'] +slug: /tools/sdk/python/v2024/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2024Tenant'] +--- + +# Tenant + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier for the Tenant | [optional] [readonly] +**name** | **str** | Abbreviated name of the Tenant | [optional] +**full_name** | **str** | Human-readable name of the Tenant | [optional] +**pod** | **str** | Deployment pod for the Tenant | [optional] +**region** | **str** | Deployment region for the Tenant | [optional] +**description** | **str** | Description of the Tenant | [optional] +**products** | [**[]Product**](product) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tenant import Tenant + +tenant = Tenant( +id='2c91808568c529c60168cca6f90c1324', +name='acme', +full_name='Acme, Inc', +pod='example-pod', +region='us-east-1', +description='Description of the Tenant', +products=[ + sailpoint.v2024.models.product.Product( + product_name = 'idn', + url = 'https://tenant-name.identitynow.com', + product_tenant_id = 'tenant#product', + product_region = 'us-east-1', + product_right = 'idn:ui:view', + api_url = 'https://tenant-name.api.identitynow.com', + licenses = [ + sailpoint.v2024.models.license.License( + license_id = 'idn:access-request', + legacy_feature_name = 'ACCESS_REQUEST', ) + ], + attributes = {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250}, + zone = 'Deployment zone for the Product', + status = 'active', + status_date_time = '2020-05-19T13:49:37.385Z', + reason = 'Reason', + notes = 'Example notes', + date_created = '2020-05-19T13:49:37.385Z', + last_updated = '2020-05-19T13:49:37.385Z', + org_type = 'test', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..13a245319 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationDetails.md @@ -0,0 +1,34 @@ +--- +id: v2024-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantConfigurationDetails', 'V2024TenantConfigurationDetails'] +slug: /tools/sdk/python/v2024/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'V2024TenantConfigurationDetails'] +--- + +# TenantConfigurationDetails + +Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**disabled** | **bool** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.tenant_configuration_details import TenantConfigurationDetails + +tenant_configuration_details = TenantConfigurationDetails( +disabled=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..08146ab8d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantConfigurationRequest', 'V2024TenantConfigurationRequest'] +slug: /tools/sdk/python/v2024/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'V2024TenantConfigurationRequest'] +--- + +# TenantConfigurationRequest + +Tenant-wide Reassignment Configuration settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config_details** | [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tenant_configuration_request import TenantConfigurationRequest + +tenant_configuration_request = TenantConfigurationRequest( +config_details=sailpoint.v2024.models.tenant_configuration_details.TenantConfigurationDetails( + disabled = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..72e0762eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TenantConfigurationResponse.md @@ -0,0 +1,45 @@ +--- +id: v2024-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantConfigurationResponse', 'V2024TenantConfigurationResponse'] +slug: /tools/sdk/python/v2024/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'V2024TenantConfigurationResponse'] +--- + +# TenantConfigurationResponse + +Tenant-wide Reassignment Configuration settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audit_details** | [**AuditDetails**](audit-details) | | [optional] +**config_details** | [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse + +tenant_configuration_response = TenantConfigurationResponse( +audit_details=sailpoint.v2024.models.audit_details.AuditDetails( + created = '2022-07-21T11:13:12.345Z', + created_by = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), + modified = '2022-07-21T11:13:12.345Z', + modified_by = sailpoint.v2024.models.identity_1.Identity_1( + id = '2c91808380aa05580180aaaaf1940410', + name = 'William Wilson', ), ), +config_details=sailpoint.v2024.models.tenant_configuration_details.TenantConfigurationDetails( + disabled = True, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..e6fe1f5a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantUiMetadataItemResponse', 'V2024TenantUiMetadataItemResponse'] +slug: /tools/sdk/python/v2024/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'V2024TenantUiMetadataItemResponse'] +--- + +# TenantUiMetadataItemResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iframe_white_list** | **str** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**username_label** | **str** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**username_empty_text** | **str** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse + +tenant_ui_metadata_item_response = TenantUiMetadataItemResponse( +iframe_white_list='http://example.com http://example2.com', +username_label='Email', +username_empty_text='Please provide your work email address...' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..ce5ec39c6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'V2024TenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/python/v2024/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'V2024TenantUiMetadataItemUpdateRequest'] +--- + +# TenantUiMetadataItemUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iframe_white_list** | **str** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**username_label** | **str** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**username_empty_text** | **str** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest + +tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest( +iframe_white_list='http://example.com http://example2.com', +username_label='Email', +username_empty_text='Please provide your work email address...' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..c865077de --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestExternalExecuteWorkflow200Response', 'V2024TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/python/v2024/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'V2024TestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payload** | **object** | The input that was received | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + +test_external_execute_workflow200_response = TestExternalExecuteWorkflow200Response( +payload={test=hello world} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..20c349f6d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestExternalExecuteWorkflowRequest', 'V2024TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/python/v2024/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'V2024TestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + +test_external_execute_workflow_request = TestExternalExecuteWorkflowRequest( +input={test=hello world} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TestInvocation.md b/docs/tools/sdk/python/Reference/V2024/Models/TestInvocation.md new file mode 100644 index 000000000..a28e18137 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TestInvocation.md @@ -0,0 +1,39 @@ +--- +id: v2024-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestInvocation', 'V2024TestInvocation'] +slug: /tools/sdk/python/v2024/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'V2024TestInvocation'] +--- + +# TestInvocation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trigger_id** | **str** | Trigger ID | [required] +**input** | **object** | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**content_json** | **object** | JSON map of invocation metadata. | [required] +**subscription_ids** | **[]str** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.test_invocation import TestInvocation + +test_invocation = TestInvocation( +trigger_id='idn:access-request-post-approval', +input={identityId=201327fda1c44704ac01181e963d463c}, +content_json={workflowId=1234}, +subscription_ids=[0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TestWorkflow200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..4ba63c936 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TestWorkflow200Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestWorkflow200Response', 'V2024TestWorkflow200Response'] +slug: /tools/sdk/python/v2024/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'V2024TestWorkflow200Response'] +--- + +# TestWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflow_execution_id** | **str** | The workflow execution id | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response + +test_workflow200_response = TestWorkflow200Response( +workflow_execution_id='0e11cefa-96e7-4b67-90d0-065bc1da5753' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TestWorkflowRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..0bba01df9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TestWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestWorkflowRequest', 'V2024TestWorkflowRequest'] +slug: /tools/sdk/python/v2024/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'V2024TestWorkflowRequest'] +--- + +# TestWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest + +test_workflow_request = TestWorkflowRequest( +input=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TextQuery.md b/docs/tools/sdk/python/Reference/V2024/Models/TextQuery.md new file mode 100644 index 000000000..ab422f773 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TextQuery.md @@ -0,0 +1,40 @@ +--- +id: v2024-text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TextQuery', 'V2024TextQuery'] +slug: /tools/sdk/python/v2024/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'V2024TextQuery'] +--- + +# TextQuery + +Query parameters used to construct an Elasticsearch text query object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terms** | **[]str** | Words or characters that specify a particular thing to be searched for. | [required] +**fields** | **[]str** | The fields to be searched. | [required] +**match_any** | **bool** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to False] +**contains** | **bool** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.text_query import TextQuery + +text_query = TextQuery( +terms=[The quick brown fox, 3141592, 7], +fields=[displayName, employeeNumber, roleCount], +match_any=False, +contains=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Transform.md b/docs/tools/sdk/python/Reference/V2024/Models/Transform.md new file mode 100644 index 000000000..e49910164 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Transform.md @@ -0,0 +1,38 @@ +--- +id: v2024-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Transform', 'V2024Transform'] +slug: /tools/sdk/python/v2024/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'V2024Transform'] +--- + +# Transform + +The representation of an internally- or customer-defined transform. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unique name of this transform | [required] +**type** | **Enum** [ 'accountAttribute', 'base64Decode', 'base64Encode', 'concat', 'conditional', 'dateCompare', 'dateFormat', 'dateMath', 'decomposeDiacriticalMarks', 'e164phone', 'firstValid', 'rule', 'identityAttribute', 'indexOf', 'iso3166', 'lastIndexOf', 'leftPad', 'lookup', 'lower', 'normalizeNames', 'randomAlphaNumeric', 'randomNumeric', 'reference', 'replaceAll', 'replace', 'rightPad', 'split', 'static', 'substring', 'trim', 'upper', 'usernameGenerator', 'uuid', 'displayName', 'rfc5646' ] | The type of transform operation | [required] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.transform import Transform + +transform = Transform( +name='Timestamp To Date', +type='dateFormat', +attributes=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TransformDefinition.md b/docs/tools/sdk/python/Reference/V2024/Models/TransformDefinition.md new file mode 100644 index 000000000..8fcdebb78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TransformDefinition.md @@ -0,0 +1,35 @@ +--- +id: v2024-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformDefinition', 'V2024TransformDefinition'] +slug: /tools/sdk/python/v2024/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024TransformDefinition'] +--- + +# TransformDefinition + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Transform definition type. | [optional] +**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.transform_definition import TransformDefinition + +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/TransformRead.md b/docs/tools/sdk/python/Reference/V2024/Models/TransformRead.md new file mode 100644 index 000000000..6905ec8f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TransformRead.md @@ -0,0 +1,41 @@ +--- +id: v2024-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformRead', 'V2024TransformRead'] +slug: /tools/sdk/python/v2024/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'V2024TransformRead'] +--- + +# TransformRead + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unique name of this transform | [required] +**type** | **Enum** [ 'accountAttribute', 'base64Decode', 'base64Encode', 'concat', 'conditional', 'dateCompare', 'dateFormat', 'dateMath', 'decomposeDiacriticalMarks', 'e164phone', 'firstValid', 'rule', 'identityAttribute', 'indexOf', 'iso3166', 'lastIndexOf', 'leftPad', 'lookup', 'lower', 'normalizeNames', 'randomAlphaNumeric', 'randomNumeric', 'reference', 'replaceAll', 'replace', 'rightPad', 'split', 'static', 'substring', 'trim', 'upper', 'usernameGenerator', 'uuid', 'displayName', 'rfc5646' ] | The type of transform operation | [required] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [required] +**id** | **str** | Unique ID of this transform | [required] +**internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to False] +} + +## Example + +```python +from sailpoint.v2024.models.transform_read import TransformRead + +transform_read = TransformRead( +name='Timestamp To Date', +type='dateFormat', +attributes=sailpoint.v2024.models.attributes.attributes(), +id='2cd78adghjkja34jh2b1hkjhasuecd', +internal=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TranslationMessage.md b/docs/tools/sdk/python/Reference/V2024/Models/TranslationMessage.md new file mode 100644 index 000000000..c6d518b1b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TranslationMessage.md @@ -0,0 +1,35 @@ +--- +id: v2024-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TranslationMessage', 'V2024TranslationMessage'] +slug: /tools/sdk/python/v2024/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'V2024TranslationMessage'] +--- + +# TranslationMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The key of the translation message | [optional] +**values** | **[]str** | The values corresponding to the translation messages | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.translation_message import TranslationMessage + +translation_message = TranslationMessage( +key='recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH', +values=[75, department] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Trigger.md b/docs/tools/sdk/python/Reference/V2024/Models/Trigger.md new file mode 100644 index 000000000..1b1db08eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Trigger.md @@ -0,0 +1,47 @@ +--- +id: v2024-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Trigger', 'V2024Trigger'] +slug: /tools/sdk/python/v2024/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'V2024Trigger'] +--- + +# Trigger + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier of the trigger. | [required] +**name** | **str** | Trigger Name. | [required] +**type** | [**TriggerType**](trigger-type) | | [required] +**description** | **str** | Trigger Description. | [optional] +**input_schema** | **str** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | [required] +**example_input** | [**TriggerExampleInput**](trigger-example-input) | | [required] +**output_schema** | **str** | 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`. | [optional] +**example_output** | [**TriggerExampleOutput**](trigger-example-output) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.trigger import Trigger + +trigger = Trigger( +id='idn:access-request-dynamic-approver', +name='Access Request Dynamic Approver', +type='FIRE_AND_FORGET', +description='Trigger for getting a dynamic approver.', +input_schema='{"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"}', +example_input=, +output_schema='{"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"}', +example_output= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TriggerExampleInput.md b/docs/tools/sdk/python/Reference/V2024/Models/TriggerExampleInput.md new file mode 100644 index 000000000..abb3c911b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TriggerExampleInput.md @@ -0,0 +1,257 @@ +--- +id: v2024-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TriggerExampleInput', 'V2024TriggerExampleInput'] +slug: /tools/sdk/python/v2024/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'V2024TriggerExampleInput'] +--- + +# TriggerExampleInput + +An example of the JSON payload that will be sent by the trigger to the subscribed service. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_request_id** | **str** | The unique ID of the access request. | [required] +**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the collection. | [required] +**started** | **datetime** | The date and time when the account collection started. | [required] +**completed** | **datetime** | The date and time when the account collection finished. | [required] +**errors** | **[]str** | A list of any accumulated error messages that occurred during provisioning. | [required] +**warnings** | **[]str** | A list of any accumulated warning messages that occurred during provisioning. | [required] +**stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] +**identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] +**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional] +**campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] +**certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] +**tracking_number** | **str** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**sources** | **str** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**action** | **str** | Origin of where the provisioning request came from. | [optional] +**recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] +**file_name** | **str** | A name for the report file. | [required] +**owner_email** | **str** | The email address of the identity that owns the saved search. | [required] +**owner_name** | **str** | The name of the identity that owns the saved search. | [required] +**query** | **str** | The search query that was used to generate the report. | [required] +**search_name** | **str** | The name of the saved search. | [required] +**search_results** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**signed_s3_url** | **str** | The Amazon S3 URL to download the report from. | [required] +**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**id** | **str** | The unique ID of the source. | [required] +**native_identifier** | **str** | Unique ID of the account on the source. | [required] +**source_id** | **str** | The ID of the source. | [required] +**source_name** | **str** | The name of the source. | [required] +**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required] +**identity_name** | **str** | The name of the identity that is correlated with this account. | [required] +**name** | **str** | The user friendly name of the source. | [required] +**type** | **str** | The connection type of the source. | [required] +**created** | **datetime** | The date and time the status change occurred. | [required] +**connector** | **str** | The connector type used to connect to the source. | [required] +**actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] +**deleted** | **datetime** | The date and time the source was deleted. | [required] +**modified** | **datetime** | The date and time the source was modified. | [required] +**application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**health_check_result** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**previous_health_check_result** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.trigger_example_input import TriggerExampleInput + +trigger_example_input = TriggerExampleInput( +access_request_id='2c91808b6ef1d43e016efba0ce470904', +requested_for=[ + sailpoint.v2024.models.access_item_requested_for_dto.AccessItemRequestedForDto( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ) + ], +requested_items=[ + sailpoint.v2024.models.access_request_pre_approval_requested_items_inner.AccessRequestPreApproval_requestedItems_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', ) + ], +requested_by=sailpoint.v2024.models.access_item_requester_dto.AccessItemRequesterDto( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_items_status=[ + sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner.AccessRequestPostApproval_requestedItemsStatus_inner( + id = '2c91808b6ef1d43e016efba0ce470904', + name = 'Engineering Access', + description = 'Access to engineering database', + type = ACCESS_PROFILE, + operation = Add, + comment = 'William needs this access to do his job.', + client_metadata = {applicationName=My application}, + approval_info = [ + sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner( + approval_comment = 'This access looks good. Approved.', + approval_decision = APPROVED, + approver_name = 'Stephen.Austin', + approver = sailpoint.v2024.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver( + type = IDENTITY, ), ) + ], ) + ], +source=sailpoint.v2024.models.account_uncorrelated_source.AccountUncorrelated_source( + type = 'SOURCE', + id = '2c6180835d191a86015d28455b4b231b', + name = 'Corporate Directory', ), +status=Success, +started='2020-06-29T22:01:50.474Z', +completed='2020-06-29T22:02:04.090Z', +errors=[ + 'Connector AD Failed' + ], +warnings=[ + 'Notification Skipped due to invalid email' + ], +stats=sailpoint.v2024.models.accounts_collected_for_aggregation_stats.AccountsCollectedForAggregation_stats( + scanned = 200, + unchanged = 190, + changed = 6, + added = 4, + removed = 3, ), +identity=sailpoint.v2024.models.identity_deleted_identity.IdentityDeleted_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +account=sailpoint.v2024.models.account_uncorrelated_account.AccountUncorrelated_account( + type = ACCOUNT, + id = '4dd497e3723e439991cb6d0e478375dd', + name = 'Sadie Jensen', + native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com', + uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ), +changes=[ + sailpoint.v2024.models.identity_attributes_changed_changes_inner.IdentityAttributesChanged_changes_inner( + attribute = 'department', + old_value = sales, + new_value = marketing, ) + ], +attributes={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}, +entitlement_count=0, +campaign=sailpoint.v2024.models.campaign_generated_campaign.CampaignGenerated_campaign( + id = '2c91808576f886190176f88cac5a0010', + name = 'Manager Access Campaign', + description = 'Audit access for all employees.', + created = '2021-02-16T03:04:45.815Z', + modified = '2021-02-17T03:04:45.815Z', + deadline = '2021-02-18T03:04:45.815Z', + type = MANAGER, + campaign_owner = sailpoint.v2024.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner( + id = '37f080867702c1910177031320c40n27', + display_name = 'John Snow', + email = 'john.snow@example.com', ), + status = STAGED, ), +certification=sailpoint.v2024.models.certification_signed_off_certification.CertificationSignedOff_certification( + id = '2c91808576f886190176f88caf0d0067', + name = 'Manager Access Review for Alice Baker', + created = '2020-02-16T03:04:45.815Z', + modified = '2020-02-16T03:06:45.815Z', ), +tracking_number='4b4d982dddff4267ab12f0f1e72b5a6d', +sources='Corp AD, Corp LDAP, Corp Salesforce', +action='IdentityRefresh', +recipient=sailpoint.v2024.models.provisioning_completed_recipient.ProvisioningCompleted_recipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +requester=sailpoint.v2024.models.provisioning_completed_requester.ProvisioningCompleted_requester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +account_requests=[ + sailpoint.v2024.models.provisioning_completed_account_requests_inner.ProvisioningCompleted_accountRequests_inner( + source = sailpoint.v2024.models.provisioning_completed_account_requests_inner_source.ProvisioningCompleted_accountRequests_inner_source( + id = '4e4d982dddff4267ab12f0f1e72b5a6d', + type = 'SOURCE', + name = 'Corporate Active Directory', ), + account_id = 'CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com', + account_operation = 'Modify', + provisioning_result = SUCCESS, + provisioning_target = 'Corp AD', + ticket_id = '72619262', + attribute_requests = [ + sailpoint.v2024.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner( + attribute_name = 'memberOf', + attribute_value = 'CN=jedi,DC=starwars,DC=com', + operation = Add, ) + ], ) + ], +file_name='Modified.zip', +owner_email='test@sailpoint.com', +owner_name='Cloud Support', +query='modified:[now-7y/d TO now]', +search_name='Modified Activity', +search_results=sailpoint.v2024.models.saved_search_complete_search_results.SavedSearchComplete_searchResults( + account = sailpoint.v2024.models.saved_search_complete_search_results_account.SavedSearchComplete_searchResults_Account( + count = '3', + noun = 'accounts', + preview = [ + [] + ], ), + entitlement = sailpoint.v2024.models.saved_search_complete_search_results_entitlement.SavedSearchComplete_searchResults_Entitlement( + count = '2', + noun = 'entitlements', + preview = [ + [] + ], ), + identity = sailpoint.v2024.models.saved_search_complete_search_results_identity.SavedSearchComplete_searchResults_Identity( + count = '2', + noun = 'identities', + preview = [ + [] + ], ), ), +signed_s3_url='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', +uuid='b7264868-7201-415f-9118-b581d431c688', +id='2c9180866166b5b0016167c32ef31a66', +native_identifier='E009', +source_id='2c918082814e693601816e09471b29b6', +source_name='Active Directory', +identity_id='ee769173319b41d19ccec6c235423237b', +identity_name='john.doe', +name='Corporate Active Directory', +type='DIRECT_CONNECT', +created='2020-06-29T22:01:50.474Z', +connector='active-directory', +actor=sailpoint.v2024.models.source_updated_actor.SourceUpdated_actor( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +deleted='2021-03-29T22:01:50.474Z', +modified='2021-03-29T22:01:50.474Z', +application=sailpoint.v2024.models.va_cluster_status_change_event_application.VAClusterStatusChangeEvent_application( + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Production VA Cluster', + attributes = { }, ), +health_check_result=sailpoint.v2024.models.va_cluster_status_change_event_health_check_result.VAClusterStatusChangeEvent_healthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Succeeded, ), +previous_health_check_result=sailpoint.v2024.models.va_cluster_status_change_event_previous_health_check_result.VAClusterStatusChangeEvent_previousHealthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Failed, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TriggerExampleOutput.md b/docs/tools/sdk/python/Reference/V2024/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..ff98a0388 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TriggerExampleOutput.md @@ -0,0 +1,44 @@ +--- +id: v2024-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TriggerExampleOutput', 'V2024TriggerExampleOutput'] +slug: /tools/sdk/python/v2024/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'V2024TriggerExampleOutput'] +--- + +# TriggerExampleOutput + +An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the identity to add to the approver list for the access request. | [required] +**name** | **str** | The name of the identity to add to the approver list for the access request. | [required] +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The type of object being referenced. | [required] +**approved** | **bool** | Whether or not to approve the access request. | [required] +**comment** | **str** | A comment about the decision to approve or deny the request. | [required] +**approver** | **str** | The name of the entity that approved or denied the request. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.trigger_example_output import TriggerExampleOutput + +trigger_example_output = TriggerExampleOutput( +id='2c91808b6ef1d43e016efba0ce470906', +name='Adam Adams', +type=IDENTITY, +approved=False, +comment='This access should be denied, because this will cause an SOD violation.', +approver='AcmeCorpExternalIntegration' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TriggerType.md b/docs/tools/sdk/python/Reference/V2024/Models/TriggerType.md new file mode 100644 index 000000000..52f325c9a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TriggerType.md @@ -0,0 +1,23 @@ +--- +id: v2024-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TriggerType', 'V2024TriggerType'] +slug: /tools/sdk/python/v2024/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'V2024TriggerType'] +--- + +# TriggerType + +The type of trigger. + +## Enum + +* `REQUEST_RESPONSE` (value: `'REQUEST_RESPONSE'`) + +* `FIRE_AND_FORGET` (value: `'FIRE_AND_FORGET'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TypeAheadQuery.md b/docs/tools/sdk/python/Reference/V2024/Models/TypeAheadQuery.md new file mode 100644 index 000000000..72c758a65 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TypeAheadQuery.md @@ -0,0 +1,46 @@ +--- +id: v2024-type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TypeAheadQuery', 'V2024TypeAheadQuery'] +slug: /tools/sdk/python/v2024/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'V2024TypeAheadQuery'] +--- + +# TypeAheadQuery + +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.\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | The type ahead query string used to construct a phrase prefix match query. | [required] +**var_field** | **str** | The field on which to perform the type ahead search. | [required] +**nested_type** | **str** | The nested type. | [optional] +**max_expansions** | **int** | 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. | [optional] [default to 10] +**size** | **int** | The max amount of records the search will return. | [optional] [default to 100] +**sort** | **str** | The sort order of the returned records. | [optional] [default to 'desc'] +**sort_by_value** | **bool** | The flag that defines the sort type, by count or value. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.type_ahead_query import TypeAheadQuery + +type_ahead_query = TypeAheadQuery( +query='Work', +var_field='source.name', +nested_type='access', +max_expansions=10, +size=100, +sort='desc', +sort_by_value=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/TypedReference.md b/docs/tools/sdk/python/Reference/V2024/Models/TypedReference.md new file mode 100644 index 000000000..495edaf93 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/TypedReference.md @@ -0,0 +1,36 @@ +--- +id: v2024-typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TypedReference', 'V2024TypedReference'] +slug: /tools/sdk/python/v2024/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'V2024TypedReference'] +--- + +# TypedReference + +A typed reference to the object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [required] +**id** | **str** | The id of the object. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.typed_reference import TypedReference + +typed_reference = TypedReference( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..02ef14d2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,34 @@ +--- +id: v2024-uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UncorrelatedAccountsReportArguments', 'V2024UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/python/v2024/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'V2024UncorrelatedAccountsReportArguments'] +--- + +# UncorrelatedAccountsReportArguments + +Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selected_formats** | **[]str** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.uncorrelated_accounts_report_arguments import UncorrelatedAccountsReportArguments + +uncorrelated_accounts_report_arguments = UncorrelatedAccountsReportArguments( +selected_formats=[CSV] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/python/Reference/V2024/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..94f9b440c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'V2024UpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/python/v2024/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'V2024UpdateAccessProfilesInBulk412Response'] +--- + +# UpdateAccessProfilesInBulk412Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.update_access_profiles_in_bulk412_response import UpdateAccessProfilesInBulk412Response + +update_access_profiles_in_bulk412_response = UpdateAccessProfilesInBulk412Response( +message= API/Feature not enabled for your organization. +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UpdateDetail.md b/docs/tools/sdk/python/Reference/V2024/Models/UpdateDetail.md new file mode 100644 index 000000000..1e997b2e9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UpdateDetail.md @@ -0,0 +1,39 @@ +--- +id: v2024-update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UpdateDetail', 'V2024UpdateDetail'] +slug: /tools/sdk/python/v2024/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'V2024UpdateDetail'] +--- + +# UpdateDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**script_name** | **str** | The connector script name | [optional] +**updated_files** | **[]str** | The list of updated files supported by the connector | [optional] +**status** | **Enum** [ 'ERROR', 'UPDATED', 'UNCHANGED', 'SKIPPED' ] | The connector update status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.update_detail import UpdateDetail + +update_detail = UpdateDetail( +message='unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config', +script_name='servicenow', +updated_files=[pod/org/connectorFiles/testconnector/test1.jar], +status='ERROR' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UsageType.md b/docs/tools/sdk/python/Reference/V2024/Models/UsageType.md new file mode 100644 index 000000000..d03a7ccb8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UsageType.md @@ -0,0 +1,51 @@ +--- +id: v2024-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UsageType', 'V2024UsageType'] +slug: /tools/sdk/python/v2024/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'V2024UsageType'] +--- + +# 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. + +## Enum + +* `CREATE` (value: `'CREATE'`) + +* `UPDATE` (value: `'UPDATE'`) + +* `ENABLE` (value: `'ENABLE'`) + +* `DISABLE` (value: `'DISABLE'`) + +* `DELETE` (value: `'DELETE'`) + +* `ASSIGN` (value: `'ASSIGN'`) + +* `UNASSIGN` (value: `'UNASSIGN'`) + +* `CREATE_GROUP` (value: `'CREATE_GROUP'`) + +* `UPDATE_GROUP` (value: `'UPDATE_GROUP'`) + +* `DELETE_GROUP` (value: `'DELETE_GROUP'`) + +* `REGISTER` (value: `'REGISTER'`) + +* `CREATE_IDENTITY` (value: `'CREATE_IDENTITY'`) + +* `UPDATE_IDENTITY` (value: `'UPDATE_IDENTITY'`) + +* `EDIT_GROUP` (value: `'EDIT_GROUP'`) + +* `UNLOCK` (value: `'UNLOCK'`) + +* `CHANGE_PASSWORD` (value: `'CHANGE_PASSWORD'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UserApp.md b/docs/tools/sdk/python/Reference/V2024/Models/UserApp.md new file mode 100644 index 000000000..83a8a83fd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UserApp.md @@ -0,0 +1,66 @@ +--- +id: v2024-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserApp', 'V2024UserApp'] +slug: /tools/sdk/python/v2024/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'V2024UserApp'] +--- + +# UserApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The user app id | [optional] +**created** | **datetime** | Time when the user app was created | [optional] +**modified** | **datetime** | Time when the user app was last modified | [optional] +**has_multiple_accounts** | **bool** | True if the owner has multiple accounts for the source | [optional] [default to False] +**use_for_password_management** | **bool** | True if the source has password feature | [optional] [default to False] +**provision_request_enabled** | **bool** | True if the source app related to the user app is provision request enabled | [optional] [default to False] +**app_center_enabled** | **bool** | True if the source app related to the user app is shown in the app center | [optional] [default to True] +**source_app** | [**UserAppSourceApp**](user-app-source-app) | | [optional] +**source** | [**UserAppSource**](user-app-source) | | [optional] +**account** | [**UserAppAccount**](user-app-account) | | [optional] +**owner** | [**UserAppOwner**](user-app-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.user_app import UserApp + +user_app = UserApp( +id='2c91808874ff91550175097daaec161c', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +has_multiple_accounts=False, +use_for_password_management=True, +provision_request_enabled=True, +app_center_enabled=True, +source_app=sailpoint.v2024.models.user_app_source_app.UserApp_sourceApp( + id = 'edcb0951812949d085b60cd8bf35bc78', + type = 'APPLICATION', + name = 'test-app', ), +source=sailpoint.v2024.models.user_app_source.UserApp_source( + id = '9870808a7190d06e01719938fcd20792', + type = 'SOURCE', + name = 'test-source', ), +account=sailpoint.v2024.models.user_app_account.UserApp_account( + id = '85d173e7d57e496569df763231d6deb6a', + type = 'ACCOUNT', + name = 'test account', ), +owner=sailpoint.v2024.models.user_app_owner.UserApp_owner( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'IDENTITY', + name = 'John', + alias = 'John.Doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UserAppAccount.md b/docs/tools/sdk/python/Reference/V2024/Models/UserAppAccount.md new file mode 100644 index 000000000..7af5b38ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UserAppAccount.md @@ -0,0 +1,37 @@ +--- +id: v2024-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppAccount', 'V2024UserAppAccount'] +slug: /tools/sdk/python/v2024/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'V2024UserAppAccount'] +--- + +# UserAppAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the account ID | [optional] +**type** | **str** | It will always be \"ACCOUNT\" | [optional] +**name** | **str** | the account name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.user_app_account import UserAppAccount + +user_app_account = UserAppAccount( +id='85d173e7d57e496569df763231d6deb6a', +type='ACCOUNT', +name='test account' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UserAppOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/UserAppOwner.md new file mode 100644 index 000000000..e09eee144 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UserAppOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppOwner', 'V2024UserAppOwner'] +slug: /tools/sdk/python/v2024/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'V2024UserAppOwner'] +--- + +# UserAppOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**type** | **str** | It will always be \"IDENTITY\" | [optional] +**name** | **str** | The identity name | [optional] +**alias** | **str** | The identity alias | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.user_app_owner import UserAppOwner + +user_app_owner = UserAppOwner( +id='2c9180827ca885d7017ca8ce28a000eb', +type='IDENTITY', +name='John', +alias='John.Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UserAppSource.md b/docs/tools/sdk/python/Reference/V2024/Models/UserAppSource.md new file mode 100644 index 000000000..eaba3ba99 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UserAppSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppSource', 'V2024UserAppSource'] +slug: /tools/sdk/python/v2024/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'V2024UserAppSource'] +--- + +# UserAppSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the source ID | [optional] +**type** | **str** | It will always be \"SOURCE\" | [optional] +**name** | **str** | the source name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.user_app_source import UserAppSource + +user_app_source = UserAppSource( +id='9870808a7190d06e01719938fcd20792', +type='SOURCE', +name='test-source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/UserAppSourceApp.md b/docs/tools/sdk/python/Reference/V2024/Models/UserAppSourceApp.md new file mode 100644 index 000000000..8949afde9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/UserAppSourceApp.md @@ -0,0 +1,37 @@ +--- +id: v2024-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UserAppSourceApp', 'V2024UserAppSourceApp'] +slug: /tools/sdk/python/v2024/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'V2024UserAppSourceApp'] +--- + +# UserAppSourceApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the source app ID | [optional] +**type** | **str** | It will always be \"APPLICATION\" | [optional] +**name** | **str** | the source app name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.user_app_source_app import UserAppSourceApp + +user_app_source_app = UserAppSourceApp( +id='edcb0951812949d085b60cd8bf35bc78', +type='APPLICATION', +name='test-app' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/V3ConnectorDto.md b/docs/tools/sdk/python/Reference/V2024/Models/V3ConnectorDto.md new file mode 100644 index 000000000..9712e839a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/V3ConnectorDto.md @@ -0,0 +1,47 @@ +--- +id: v2024-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'V3ConnectorDto', 'V2024V3ConnectorDto'] +slug: /tools/sdk/python/v2024/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V2024V3ConnectorDto'] +--- + +# V3ConnectorDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The connector name | [optional] +**type** | **str** | The connector type | [optional] +**script_name** | **str** | The connector script name | [optional] +**class_name** | **str** | The connector class name. | [optional] +**features** | **[]str** | The list of features supported by the connector | [optional] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to False] +**connector_metadata** | **map[string]object** | A map containing metadata pertinent to the connector | [optional] +**status** | **Enum** [ 'DEPRECATED', 'DEVELOPMENT', 'DEMO', 'RELEASED' ] | The connector status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto + +v3_connector_dto = V3ConnectorDto( +name='name', +type='ServiceNow', +script_name='servicenow', +class_name='sailpoint.connector.OpenConnectorAdapter', +features=[PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS], +direct_connect=True, +connector_metadata={supportedUI=ANGULAR, platform=ccg, shortDesc=connector description}, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/V3CreateConnectorDto.md b/docs/tools/sdk/python/Reference/V2024/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..8c1185a85 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/V3CreateConnectorDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'V3CreateConnectorDto', 'V2024V3CreateConnectorDto'] +slug: /tools/sdk/python/v2024/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V2024V3CreateConnectorDto'] +--- + +# V3CreateConnectorDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | 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 | [required] +**type** | **str** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**class_name** | **str** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | [required] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to True] +**status** | **Enum** [ 'DEVELOPMENT', 'DEMO', 'RELEASED' ] | The connector status | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.v3_create_connector_dto import V3CreateConnectorDto + +v3_create_connector_dto = V3CreateConnectorDto( +name='custom connector', +type='custom connector type', +class_name='sailpoint.connector.OpenConnectorAdapter', +direct_connect=True, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..3d788c780 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,50 @@ +--- +id: v2024-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEvent', 'V2024VAClusterStatusChangeEvent'] +slug: /tools/sdk/python/v2024/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'V2024VAClusterStatusChangeEvent'] +--- + +# VAClusterStatusChangeEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | The date and time the status change occurred. | [required] +**type** | **Enum** [ 'SOURCE', 'CLUSTER' ] | The type of the object that initiated this event. | [required] +**application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**health_check_result** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**previous_health_check_result** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.va_cluster_status_change_event import VAClusterStatusChangeEvent + +va_cluster_status_change_event = VAClusterStatusChangeEvent( +created='2020-06-29T22:01:50.474Z', +type=CLUSTER, +application=sailpoint.v2024.models.va_cluster_status_change_event_application.VAClusterStatusChangeEvent_application( + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Production VA Cluster', + attributes = { }, ), +health_check_result=sailpoint.v2024.models.va_cluster_status_change_event_health_check_result.VAClusterStatusChangeEvent_healthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Succeeded, ), +previous_health_check_result=sailpoint.v2024.models.va_cluster_status_change_event_previous_health_check_result.VAClusterStatusChangeEvent_previousHealthCheckResult( + message = 'Test Connection failed with exception. Error message - java.lang Exception', + result_type = 'SOURCE_STATE_ERROR_CLUSTER', + status = Failed, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..e1855d64a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,38 @@ +--- +id: v2024-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEventApplication', 'V2024VAClusterStatusChangeEventApplication'] +slug: /tools/sdk/python/v2024/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'V2024VAClusterStatusChangeEventApplication'] +--- + +# VAClusterStatusChangeEventApplication + +Details about the `CLUSTER` or `SOURCE` that initiated this event. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The GUID of the application | [required] +**name** | **str** | The name of the application | [required] +**attributes** | **map[string]object** | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.va_cluster_status_change_event_application import VAClusterStatusChangeEventApplication + +va_cluster_status_change_event_application = VAClusterStatusChangeEventApplication( +id='2c9180866166b5b0016167c32ef31a66', +name='Production VA Cluster', +attributes={ } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..615857c70 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,38 @@ +--- +id: v2024-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'V2024VAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/python/v2024/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'V2024VAClusterStatusChangeEventHealthCheckResult'] +--- + +# VAClusterStatusChangeEventHealthCheckResult + +The results of the most recent health check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Detailed message of the result of the health check. | [required] +**result_type** | **str** | The type of the health check result. | [required] +**status** | **Enum** [ 'Succeeded', 'Failed' ] | The status of the health check. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.va_cluster_status_change_event_health_check_result import VAClusterStatusChangeEventHealthCheckResult + +va_cluster_status_change_event_health_check_result = VAClusterStatusChangeEventHealthCheckResult( +message='Test Connection failed with exception. Error message - java.lang Exception', +result_type='SOURCE_STATE_ERROR_CLUSTER', +status=Succeeded +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..ea0e1f451 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,38 @@ +--- +id: v2024-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2024VAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/python/v2024/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2024VAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +The results of the last health check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Detailed message of the result of the health check. | [required] +**result_type** | **str** | The type of the health check result. | [required] +**status** | **Enum** [ 'Succeeded', 'Failed' ] | The status of the health check. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.va_cluster_status_change_event_previous_health_check_result import VAClusterStatusChangeEventPreviousHealthCheckResult + +va_cluster_status_change_event_previous_health_check_result = VAClusterStatusChangeEventPreviousHealthCheckResult( +message='Test Connection failed with exception. Error message - java.lang Exception', +result_type='SOURCE_STATE_ERROR_CLUSTER', +status=Failed +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ValidateFilterInputDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..ae71bce38 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ValidateFilterInputDto.md @@ -0,0 +1,35 @@ +--- +id: v2024-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ValidateFilterInputDto', 'V2024ValidateFilterInputDto'] +slug: /tools/sdk/python/v2024/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'V2024ValidateFilterInputDto'] +--- + +# ValidateFilterInputDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | Mock input to evaluate filter expression against. | [required] +**filter** | **str** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.validate_filter_input_dto import ValidateFilterInputDto + +validate_filter_input_dto = ValidateFilterInputDto( +input={identityId=201327fda1c44704ac01181e963d463c}, +filter='$[?($.identityId == "201327fda1c44704ac01181e963d463c")]' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..902a40031 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ValidateFilterOutputDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ValidateFilterOutputDto', 'V2024ValidateFilterOutputDto'] +slug: /tools/sdk/python/v2024/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'V2024ValidateFilterOutputDto'] +--- + +# ValidateFilterOutputDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**is_valid** | **bool** | When this field is true, the filter expression is valid against the input. | [optional] [default to False] +**is_valid_json_path** | **bool** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to False] +**is_path_exist** | **bool** | When this field is true, the filter expression is using an existing path. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.validate_filter_output_dto import ValidateFilterOutputDto + +validate_filter_output_dto = ValidateFilterOutputDto( +is_valid=True, +is_valid_json_path=True, +is_path_exist=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Value.md b/docs/tools/sdk/python/Reference/V2024/Models/Value.md new file mode 100644 index 000000000..b9a540c8c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Value.md @@ -0,0 +1,35 @@ +--- +id: v2024-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Value', 'V2024Value'] +slug: /tools/sdk/python/v2024/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'V2024Value'] +--- + +# Value + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of attribute value | [optional] +**value** | **str** | The attribute value | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.value import Value + +value = Value( +type='STRING', +value='Austin' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMapping.md b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..cbcb49705 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMapping.md @@ -0,0 +1,57 @@ +--- +id: v2024-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMapping', 'V2024VendorConnectorMapping'] +slug: /tools/sdk/python/v2024/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'V2024VendorConnectorMapping'] +--- + +# VendorConnectorMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier for the vendor-connector mapping. | [optional] +**vendor** | **str** | The name of the vendor. | [optional] +**connector** | **str** | The name of the connector. | [optional] +**created_at** | **datetime** | The creation timestamp of the mapping. | [optional] +**created_by** | **str** | The identifier of the user who created the mapping. | [optional] +**updated_at** | [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**updated_by** | [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**deleted_at** | [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**deleted_by** | [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping + +vendor_connector_mapping = VendorConnectorMapping( +id='78733556-9ea3-4f59-bf69-e5cd92b011b4', +vendor='Example vendor', +connector='Example connector', +created_at='2024-03-13T12:56:19.391294Z', +created_by='admin', +updated_at=sailpoint.v2024.models.vendor_connector_mapping_updated_at.VendorConnectorMapping_updatedAt( + time = '2024-03-14T12:56:19.391294Z', + valid = True, ), +updated_by=sailpoint.v2024.models.vendor_connector_mapping_updated_by.VendorConnectorMapping_updatedBy( + string = 'user-67891', + valid = True, ), +deleted_at=sailpoint.v2024.models.vendor_connector_mapping_deleted_at.VendorConnectorMapping_deletedAt( + time = '0001-01-01T00:00Z', + valid = False, ), +deleted_by=sailpoint.v2024.models.vendor_connector_mapping_deleted_by.VendorConnectorMapping_deletedBy( + string = '', + valid = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..e240a0d0a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,36 @@ +--- +id: v2024-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingDeletedAt', 'V2024VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/python/v2024/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'V2024VendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +An object representing the nullable timestamp of when the mapping was deleted. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**valid** | **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.vendor_connector_mapping_deleted_at import VendorConnectorMappingDeletedAt + +vendor_connector_mapping_deleted_at = VendorConnectorMappingDeletedAt( +time='0001-01-01T00:00Z', +valid=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..36510da25 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,36 @@ +--- +id: v2024-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingDeletedBy', 'V2024VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/python/v2024/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'V2024VendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +An object representing the nullable identifier of the user who deleted the mapping. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**string** | **str** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**valid** | **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.vendor_connector_mapping_deleted_by import VendorConnectorMappingDeletedBy + +vendor_connector_mapping_deleted_by = VendorConnectorMappingDeletedBy( +string='', +valid=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..ce896b0a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,36 @@ +--- +id: v2024-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingUpdatedAt', 'V2024VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/python/v2024/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'V2024VendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +An object representing the nullable timestamp of the last update. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**valid** | **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.vendor_connector_mapping_updated_at import VendorConnectorMappingUpdatedAt + +vendor_connector_mapping_updated_at = VendorConnectorMappingUpdatedAt( +time='2024-03-14T12:56:19.391294Z', +valid=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..8719a6091 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,36 @@ +--- +id: v2024-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingUpdatedBy', 'V2024VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/python/v2024/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'V2024VendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +An object representing the nullable identifier of the user who last updated the mapping. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**string** | **str** | The identifier of the user who last updated the mapping, if available. | [optional] +**valid** | **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.vendor_connector_mapping_updated_by import VendorConnectorMappingUpdatedBy + +vendor_connector_mapping_updated_by = VendorConnectorMappingUpdatedBy( +string='user-67891', +valid=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ViolationContext.md b/docs/tools/sdk/python/Reference/V2024/Models/ViolationContext.md new file mode 100644 index 000000000..853dfe36a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ViolationContext.md @@ -0,0 +1,40 @@ +--- +id: v2024-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationContext', 'V2024ViolationContext'] +slug: /tools/sdk/python/v2024/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'V2024ViolationContext'] +--- + +# ViolationContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**conflicting_access_criteria** | [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.violation_context import ViolationContext + +violation_context = ViolationContext( +policy=sailpoint.v2024.models.violation_context_policy.ViolationContext_policy( + type = ENTITLEMENT, ), +conflicting_access_criteria=sailpoint.v2024.models.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/ViolationContextPolicy.md b/docs/tools/sdk/python/Reference/V2024/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..eb9d88c81 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ViolationContextPolicy.md @@ -0,0 +1,38 @@ +--- +id: v2024-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationContextPolicy', 'V2024ViolationContextPolicy'] +slug: /tools/sdk/python/v2024/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'V2024ViolationContextPolicy'] +--- + +# ViolationContextPolicy + +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** | SOD policy ID. | [optional] +**name** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.violation_context_policy import ViolationContextPolicy + +violation_context_policy = ViolationContextPolicy( +type=ENTITLEMENT, +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='A very cool policy name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..eed92c8cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,38 @@ +--- +id: v2024-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationOwnerAssignmentConfig', 'V2024ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/python/v2024/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'V2024ViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignment_rule** | **Enum** [ 'MANAGER', 'STATIC' ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**owner_ref** | [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.violation_owner_assignment_config import ViolationOwnerAssignmentConfig + +violation_owner_assignment_config = ViolationOwnerAssignmentConfig( +assignment_rule='MANAGER', +owner_ref=sailpoint.v2024.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/python/Reference/V2024/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..8e9b7d5ec --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,38 @@ +--- +id: v2024-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2024ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/python/v2024/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2024ViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +The owner of the violation assignment config. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP', 'MANAGER' ] | Owner type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.violation_owner_assignment_config_owner_ref import ViolationOwnerAssignmentConfigOwnerRef + +violation_owner_assignment_config_owner_ref = ViolationOwnerAssignmentConfigOwnerRef( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ViolationPrediction.md b/docs/tools/sdk/python/Reference/V2024/Models/ViolationPrediction.md new file mode 100644 index 000000000..386398ab4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ViolationPrediction.md @@ -0,0 +1,43 @@ +--- +id: v2024-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationPrediction', 'V2024ViolationPrediction'] +slug: /tools/sdk/python/v2024/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'V2024ViolationPrediction'] +--- + +# ViolationPrediction + +An object containing a listing of the SOD violation reasons detected by this check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**violation_contexts** | [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.violation_prediction import ViolationPrediction + +violation_prediction = ViolationPrediction( +violation_contexts=[ + sailpoint.v2024.models.violation_context.ViolationContext( + policy = sailpoint.v2024.models.violation_context_policy.ViolationContext_policy( + type = ENTITLEMENT, ), + conflicting_access_criteria = sailpoint.v2024.models.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/VisibilityCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/VisibilityCriteria.md new file mode 100644 index 000000000..435307abb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/VisibilityCriteria.md @@ -0,0 +1,38 @@ +--- +id: v2024-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VisibilityCriteria', 'V2024VisibilityCriteria'] +slug: /tools/sdk/python/v2024/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'V2024VisibilityCriteria'] +--- + +# VisibilityCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | [**Expression**](expression) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.visibility_criteria import VisibilityCriteria + +visibility_criteria = VisibilityCriteria( +expression=sailpoint.v2024.models.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/WorkItemForward.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemForward.md new file mode 100644 index 000000000..251065494 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemForward.md @@ -0,0 +1,37 @@ +--- +id: v2024-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemForward', 'V2024WorkItemForward'] +slug: /tools/sdk/python/v2024/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'V2024WorkItemForward'] +--- + +# WorkItemForward + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_owner_id** | **str** | The ID of the identity to forward this work item to. | [required] +**comment** | **str** | Comments to send to the target owner | [required] +**send_notifications** | **bool** | If true, send a notification to the target owner. | [optional] [default to True] +} + +## Example + +```python +from sailpoint.v2024.models.work_item_forward import WorkItemForward + +work_item_forward = WorkItemForward( +target_owner_id='2c9180835d2e5168015d32f890ca1581', +comment='I'm going on vacation.', +send_notifications=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkItemState.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemState.md new file mode 100644 index 000000000..7bf37bd29 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemState.md @@ -0,0 +1,31 @@ +--- +id: v2024-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemState', 'V2024WorkItemState'] +slug: /tools/sdk/python/v2024/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'V2024WorkItemState'] +--- + +# WorkItemState + +The state of a work item + +## Enum + +* `FINISHED` (value: `'Finished'`) + +* `REJECTED` (value: `'Rejected'`) + +* `RETURNED` (value: `'Returned'`) + +* `EXPIRED` (value: `'Expired'`) + +* `PENDING` (value: `'Pending'`) + +* `CANCELED` (value: `'Canceled'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..9fb900105 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,31 @@ +--- +id: v2024-work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemStateManualWorkItems', 'V2024WorkItemStateManualWorkItems'] +slug: /tools/sdk/python/v2024/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'V2024WorkItemStateManualWorkItems'] +--- + +# WorkItemStateManualWorkItems + +The state of a work item + +## Enum + +* `FINISHED` (value: `'Finished'`) + +* `REJECTED` (value: `'Rejected'`) + +* `RETURNED` (value: `'Returned'`) + +* `EXPIRED` (value: `'Expired'`) + +* `PENDING` (value: `'Pending'`) + +* `CANCELED` (value: `'Canceled'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..41f1f8be9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,47 @@ +--- +id: v2024-work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemTypeManualWorkItems', 'V2024WorkItemTypeManualWorkItems'] +slug: /tools/sdk/python/v2024/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'V2024WorkItemTypeManualWorkItems'] +--- + +# WorkItemTypeManualWorkItems + +The type of the work item + +## Enum + +* `GENERIC` (value: `'Generic'`) + +* `CERTIFICATION` (value: `'Certification'`) + +* `REMEDIATION` (value: `'Remediation'`) + +* `DELEGATION` (value: `'Delegation'`) + +* `APPROVAL` (value: `'Approval'`) + +* `VIOLATIONREVIEW` (value: `'ViolationReview'`) + +* `FORM` (value: `'Form'`) + +* `POLICYVIOLOATION` (value: `'PolicyVioloation'`) + +* `CHALLENGE` (value: `'Challenge'`) + +* `IMPACTANALYSIS` (value: `'ImpactAnalysis'`) + +* `SIGNOFF` (value: `'Signoff'`) + +* `EVENT` (value: `'Event'`) + +* `MANUALACTION` (value: `'ManualAction'`) + +* `TEST` (value: `'Test'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkItems.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItems.md new file mode 100644 index 000000000..ec903b6f8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItems.md @@ -0,0 +1,85 @@ +--- +id: v2024-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItems', 'V2024WorkItems'] +slug: /tools/sdk/python/v2024/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2024WorkItems'] +--- + +# WorkItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the work item | [optional] +**requester_id** | **str** | ID of the requester | [optional] +**requester_display_name** | **str** | The displayname of the requester | [optional] +**owner_id** | **str** | The ID of the owner | [optional] +**owner_name** | **str** | The name of the owner | [optional] +**created** | **datetime** | Time when the work item was created | [optional] +**modified** | **datetime** | Time when the work item was last updated | [optional] +**description** | **str** | The description of the work item | [optional] +**state** | [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**type** | [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**remediation_items** | [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**approval_items** | [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**name** | **str** | The work item name | [optional] +**completed** | **datetime** | The time at which the work item completed | [optional] +**num_items** | **int** | The number of items in the work item | [optional] +**form** | [**WorkItemsForm**](work-items-form) | | [optional] +**errors** | **[]str** | An array of errors that ocurred during the work item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.work_items import WorkItems + +work_items = WorkItems( +id='2c9180835d2e5168015d32f890ca1581', +requester_id='2c9180835d2e5168015d32f890ca1581', +requester_display_name='John Smith', +owner_id='2c9180835d2e5168015d32f890ca1581', +owner_name='Jason Smith', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +description='Create account on source 'AD'', +state='Finished', +type='Generic', +remediation_items=[ + sailpoint.v2024.models.remediation_item_details.RemediationItemDetails( + id = '2c9180835d2e5168015d32f890ca1581', + target_id = '2c9180835d2e5168015d32f890ca1581', + target_name = 'john.smith', + target_display_name = 'emailAddress', + application_name = 'Active Directory', + attribute_name = 'phoneNumber', + attribute_operation = 'update', + attribute_value = '512-555-1212', + native_identity = 'jason.smith2', ) + ], +approval_items=[ + sailpoint.v2024.models.approval_item_details.ApprovalItemDetails( + id = '2c9180835d2e5168015d32f890ca1581', + account = 'john.smith', + application = 'Active Directory', + name = 'emailAddress', + operation = 'update', + value = 'a@b.com', + state = null, ) + ], +name='Account Create', +completed='2018-10-19T13:49:37.385Z', +num_items=19, +form=, +errors=[The work item ID that was specified was not found.] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsCount.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsCount.md new file mode 100644 index 000000000..344c1d30b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsCount.md @@ -0,0 +1,33 @@ +--- +id: v2024-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsCount', 'V2024WorkItemsCount'] +slug: /tools/sdk/python/v2024/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'V2024WorkItemsCount'] +--- + +# WorkItemsCount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | The count of work items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.work_items_count import WorkItemsCount + +work_items_count = WorkItemsCount( +count=29 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsForm.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsForm.md new file mode 100644 index 000000000..8feaecaf0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsForm.md @@ -0,0 +1,45 @@ +--- +id: v2024-work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsForm', 'V2024WorkItemsForm'] +slug: /tools/sdk/python/v2024/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'V2024WorkItemsForm'] +--- + +# WorkItemsForm + + +## 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.work_items_form import WorkItemsForm + +work_items_form = WorkItemsForm( +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/WorkItemsSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsSummary.md new file mode 100644 index 000000000..936cd6501 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkItemsSummary.md @@ -0,0 +1,37 @@ +--- +id: v2024-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsSummary', 'V2024WorkItemsSummary'] +slug: /tools/sdk/python/v2024/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'V2024WorkItemsSummary'] +--- + +# WorkItemsSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**open** | **int** | The count of open work items | [optional] +**completed** | **int** | The count of completed work items | [optional] +**total** | **int** | The count of total work items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.work_items_summary import WorkItemsSummary + +work_items_summary = WorkItemsSummary( +open=29, +completed=1, +total=30 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Workflow.md b/docs/tools/sdk/python/Reference/V2024/Models/Workflow.md new file mode 100644 index 000000000..a4174b5f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Workflow.md @@ -0,0 +1,71 @@ +--- +id: v2024-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Workflow', 'V2024Workflow'] +slug: /tools/sdk/python/v2024/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'V2024Workflow'] +--- + +# Workflow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [optional] +**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] +**id** | **str** | Workflow ID. This is a UUID generated upon creation. | [optional] +**execution_count** | **int** | The number of times this workflow has been executed. | [optional] +**failure_count** | **int** | The number of times this workflow has failed during execution. | [optional] +**created** | **datetime** | The date and time the workflow was created. | [optional] +**modified** | **datetime** | The date and time the workflow was modified. | [optional] +**modified_by** | [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**creator** | [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow import Workflow + +workflow = Workflow( +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, ), +id='d201c5e9-d37b-4aff-af14-66414f39d569', +execution_count=2, +failure_count=0, +created='2022-01-10T16:06:16.636381447Z', +modified='2023-12-05T15:18:27.699132301Z', +modified_by=sailpoint.v2024.models.workflow_modified_by.WorkflowModifiedBy( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ), +creator=sailpoint.v2024.models.workflow_all_of_creator.Workflow_allOf_creator( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..c9554891c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowAllOfCreator.md @@ -0,0 +1,38 @@ +--- +id: v2024-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowAllOfCreator', 'V2024WorkflowAllOfCreator'] +slug: /tools/sdk/python/v2024/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'V2024WorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +Workflow creator's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Workflow creator's DTO type. | [optional] +**id** | **str** | Workflow creator's identity ID. | [optional] +**name** | **str** | Workflow creator's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_all_of_creator import WorkflowAllOfCreator + +workflow_all_of_creator = WorkflowAllOfCreator( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowBody.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowBody.md new file mode 100644 index 000000000..a72ba54b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowBody.md @@ -0,0 +1,51 @@ +--- +id: v2024-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowBody', 'V2024WorkflowBody'] +slug: /tools/sdk/python/v2024/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'V2024WorkflowBody'] +--- + +# WorkflowBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [optional] +**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.workflow_body import WorkflowBody + +workflow_body = WorkflowBody( +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/WorkflowBodyOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..f69abfc4d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowBodyOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowBodyOwner', 'V2024WorkflowBodyOwner'] +slug: /tools/sdk/python/v2024/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'V2024WorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [optional] +**id** | **str** | The unique ID of the object | [optional] +**name** | **str** | The name of the object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_body_owner import WorkflowBodyOwner + +workflow_body_owner = WorkflowBodyOwner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowDefinition.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowDefinition.md new file mode 100644 index 000000000..92652ff03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowDefinition.md @@ -0,0 +1,36 @@ +--- +id: v2024-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowDefinition', 'V2024WorkflowDefinition'] +slug: /tools/sdk/python/v2024/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'V2024WorkflowDefinition'] +--- + +# WorkflowDefinition + +The map of steps that the workflow will execute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **str** | The name of the starting step. | [optional] +**steps** | **map[string]object** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_definition import WorkflowDefinition + +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}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md new file mode 100644 index 000000000..f0ff7ce47 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md @@ -0,0 +1,43 @@ +--- +id: v2024-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowExecution', 'V2024WorkflowExecution'] +slug: /tools/sdk/python/v2024/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'V2024WorkflowExecution'] +--- + +# WorkflowExecution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Workflow execution ID. | [optional] +**workflow_id** | **str** | Workflow ID. | [optional] +**request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**start_time** | **datetime** | Date/time when the workflow started. | [optional] +**close_time** | **datetime** | Date/time when the workflow ended. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_execution import WorkflowExecution + +workflow_execution = WorkflowExecution( +id='b393f4e2-4785-4d7f-ab27-3a6b8ded4c81', +workflow_id='d201c5d9-d37b-4a2f-af14-66414f39d568', +request_id='41e12a74fa7b4a6a98ae47887b64acdb', +start_time='2022-02-07T20:13:29.356648026Z', +close_time='2022-02-07T20:13:31.682410165Z', +status='Completed' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..c9aebbcea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecutionEvent.md @@ -0,0 +1,37 @@ +--- +id: v2024-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowExecutionEvent', 'V2024WorkflowExecutionEvent'] +slug: /tools/sdk/python/v2024/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'V2024WorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WorkflowExecutionScheduled', 'WorkflowExecutionStarted', 'WorkflowExecutionCompleted', 'WorkflowExecutionFailed', 'WorkflowTaskScheduled', 'WorkflowTaskStarted', 'WorkflowTaskCompleted', 'WorkflowTaskFailed', 'ActivityTaskScheduled', 'ActivityTaskStarted', 'ActivityTaskCompleted', 'ActivityTaskFailed', 'StartChildWorkflowExecutionInitiated', 'ChildWorkflowExecutionStarted', 'ChildWorkflowExecutionCompleted', 'ChildWorkflowExecutionFailed' ] | The type of event | [optional] +**timestamp** | **datetime** | The date-time when the event occurred | [optional] +**attributes** | **object** | Additional attributes associated with the event | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent + +workflow_execution_event = WorkflowExecutionEvent( +type='WorkflowTaskScheduled', +timestamp='2022-02-07T20:13:31.640618296Z', +attributes={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryAction.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..5d79c0317 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryAction.md @@ -0,0 +1,63 @@ +--- +id: v2024-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryAction', 'V2024WorkflowLibraryAction'] +slug: /tools/sdk/python/v2024/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'V2024WorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Action ID. This is a static namespaced ID for the action | [optional] +**name** | **str** | Action Name | [optional] +**type** | **str** | Action type | [optional] +**description** | **str** | Action Description | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**example_output** | [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**version_number** | **int** | Version number | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to False] +**output_schema** | **object** | Defines the output schema, if any, that this action produces. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction + +workflow_library_action = WorkflowLibraryAction( +id='sp:create-campaign', +name='Create Certification Campaign', +type='ACTION', +description='Generates a certification campaign.', +form_fields=[ + sailpoint.v2024.models.workflow_library_form_fields.WorkflowLibraryFormFields( + description = 'First value to compare', + help_text = 'The name to give to this certification campaign.', + label = 'Campaign Name', + name = 'name', + required = False, + type = 'text', ) + ], +example_output=, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +version_number=56, +is_simulation_enabled=True, +is_dynamic_schema=False, +output_schema={definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..bf53969d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,31 @@ +--- +id: v2024-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryActionExampleOutput', 'V2024WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/python/v2024/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'V2024WorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.workflow_library_action_example_output import WorkflowLibraryActionExampleOutput + +workflow_library_action_example_output = WorkflowLibraryActionExampleOutput( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..dff29b801 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,43 @@ +--- +id: v2024-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryFormFields', 'V2024WorkflowLibraryFormFields'] +slug: /tools/sdk/python/v2024/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'V2024WorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Description of the form field | [optional] +**help_text** | **str** | Describes the form field in the UI | [optional] +**label** | **str** | A human readable name for this form field in the UI | [optional] +**name** | **str** | The name of the input attribute | [optional] +**required** | **bool** | Denotes if this field is a required attribute | [optional] [default to False] +**type** | **Enum** [ 'text', 'textarea', 'boolean', 'email', 'url', 'number', 'json', 'checkbox', 'jsonpath', 'select', 'multiType', 'duration', 'toggle', 'formPicker', 'identityPicker', 'governanceGroupPicker', 'string', 'object', 'array', 'secret', 'keyValuePairs', 'emailPicker', 'advancedToggle', 'variableCreator', 'htmlEditor' ] | The type of the form field | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_library_form_fields import WorkflowLibraryFormFields + +workflow_library_form_fields = WorkflowLibraryFormFields( +description='First value to compare', +help_text='The name to give to this certification campaign.', +label='Campaign Name', +name='name', +required=False, +type='text' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..6a969b0fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryOperator.md @@ -0,0 +1,49 @@ +--- +id: v2024-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryOperator', 'V2024WorkflowLibraryOperator'] +slug: /tools/sdk/python/v2024/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'V2024WorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Operator ID. | [optional] +**name** | **str** | Operator friendly name | [optional] +**type** | **str** | Operator type | [optional] +**description** | **str** | Description of the operator | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator + +workflow_library_operator = WorkflowLibraryOperator( +id='sp:compare-boolean', +name='Compare Boolean Values', +type='OPERATOR', +description='Compare two boolean values and decide what happens based on the result.', +is_dynamic_schema=False, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +is_simulation_enabled=True, +form_fields=[{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..7a9c543d2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,53 @@ +--- +id: v2024-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryTrigger', 'V2024WorkflowLibraryTrigger'] +slug: /tools/sdk/python/v2024/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'V2024WorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**type** | **Enum** [ 'EVENT', 'SCHEDULED', 'EXTERNAL' ] | Trigger type | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**output_schema** | **object** | Example output schema | [optional] +**name** | **str** | Trigger Name | [optional] +**description** | **str** | Trigger Description | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to False] +**input_example** | **object** | Example trigger payload if applicable | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger + +workflow_library_trigger = WorkflowLibraryTrigger( +id='idn:identity-attributes-changed', +type='EVENT', +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +is_simulation_enabled=True, +output_schema=None, +name='Identity Attributes Changed', +description='One or more identity attributes changed.', +is_dynamic_schema=False, +input_example={changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}}, +form_fields=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowModifiedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..a1d27ab35 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowModifiedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowModifiedBy', 'V2024WorkflowModifiedBy'] +slug: /tools/sdk/python/v2024/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'V2024WorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | | [optional] +**id** | **str** | Identity ID | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_modified_by import WorkflowModifiedBy + +workflow_modified_by = WorkflowModifiedBy( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowOAuthClient.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..a07d35036 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowOAuthClient.md @@ -0,0 +1,37 @@ +--- +id: v2024-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowOAuthClient', 'V2024WorkflowOAuthClient'] +slug: /tools/sdk/python/v2024/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'V2024WorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**secret** | **str** | OAuthClient secret. | [optional] +**url** | **str** | URL for the external trigger to invoke | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient + +workflow_o_auth_client = WorkflowOAuthClient( +id='1a58c03a6bf64dc2876f6988c6e2c7b7', +secret='00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowTrigger.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowTrigger.md new file mode 100644 index 000000000..d7c6b9d42 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowTrigger.md @@ -0,0 +1,38 @@ +--- +id: v2024-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowTrigger', 'V2024WorkflowTrigger'] +slug: /tools/sdk/python/v2024/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'V2024WorkflowTrigger'] +--- + +# WorkflowTrigger + +The trigger that starts the workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'EVENT', 'EXTERNAL', 'SCHEDULED', '' ] | The trigger type | [required] +**display_name** | **str** | | [optional] +**attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_trigger import WorkflowTrigger + +workflow_trigger = WorkflowTrigger( +type='EVENT', +display_name='', +attributes= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowTriggerAttributes.md new file mode 100644 index 000000000..b8d5e27c9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowTriggerAttributes.md @@ -0,0 +1,56 @@ +--- +id: v2024-workflow-trigger-attributes +title: WorkflowTriggerAttributes +pagination_label: WorkflowTriggerAttributes +sidebar_label: WorkflowTriggerAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowTriggerAttributes', 'V2024WorkflowTriggerAttributes'] +slug: /tools/sdk/python/v2024/models/workflow-trigger-attributes +tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'V2024WorkflowTriggerAttributes'] +--- + +# WorkflowTriggerAttributes + +Workflow Trigger Attributes. + +## 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** | Additonal context about the external trigger | [optional] +**attribute_to_filter** | **str** | The attribute to filter on | [optional] +**name** | **str** | A unique name for the external trigger | [optional] +**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional] +**url** | **str** | URL to invoke this workflow | [optional] +**cron_string** | **str** | A valid CRON expression | [optional] +**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required] +**time_zone** | **str** | Time zone identifier | [optional] +**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional] +**weekly_times** | **[]str** | Scheduled execution times | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workflow_trigger_attributes import WorkflowTriggerAttributes + +workflow_trigger_attributes = WorkflowTriggerAttributes( +id='idn:identity-attributes-changed', +filter_='$.changes[?(@.attribute == 'manager')]', +description='Run a search and notify the results', +attribute_to_filter='LifecycleState', +name='search-and-notify', +client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d', +cron_string='0 9 * * 1', +frequency='daily', +time_zone='America/Chicago', +weekly_days=Monday, +weekly_times=Monday +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..5a1c2e1cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupBulkDeleteRequest', 'V2024WorkgroupBulkDeleteRequest'] +slug: /tools/sdk/python/v2024/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'V2024WorkgroupBulkDeleteRequest'] +--- + +# WorkgroupBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of IDs of Governance Groups to be deleted. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest + +workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest( +ids=[567a697e-885b-495a-afc5-d55e1c23a302, c7b0f7b2-1e78-4063-b294-a555333dacd2] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..c1b87fe85 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupConnectionDto.md @@ -0,0 +1,35 @@ +--- +id: v2024-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupConnectionDto', 'V2024WorkgroupConnectionDto'] +slug: /tools/sdk/python/v2024/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'V2024WorkgroupConnectionDto'] +--- + +# WorkgroupConnectionDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | [**WorkgroupConnectionDtoObject**](workgroup-connection-dto-object) | | [optional] +**connection_type** | **Enum** [ 'AccessRequestReviewer', 'Owner', 'ManagementWorkgroup' ] | Connection Type. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_connection_dto import WorkgroupConnectionDto + +workgroup_connection_dto = WorkgroupConnectionDto( +object=, +connection_type='AccessRequestReviewer' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupConnectionDtoObject.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupConnectionDtoObject.md new file mode 100644 index 000000000..58831c705 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupConnectionDtoObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-workgroup-connection-dto-object +title: WorkgroupConnectionDtoObject +pagination_label: WorkgroupConnectionDtoObject +sidebar_label: WorkgroupConnectionDtoObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupConnectionDtoObject', 'V2024WorkgroupConnectionDtoObject'] +slug: /tools/sdk/python/v2024/models/workgroup-connection-dto-object +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDtoObject', 'V2024WorkgroupConnectionDtoObject'] +--- + +# WorkgroupConnectionDtoObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ConnectedObjectType**](connected-object-type) | | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable name of Connected object | [optional] +**description** | **str** | Description of the Connected object. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_connection_dto_object import WorkgroupConnectionDtoObject + +workgroup_connection_dto_object = WorkgroupConnectionDtoObject( +type=, +id='2c91808568c529c60168cca6f90c1313', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..e03596f19 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDeleteItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupDeleteItem', 'V2024WorkgroupDeleteItem'] +slug: /tools/sdk/python/v2024/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'V2024WorkgroupDeleteItem'] +--- + +# WorkgroupDeleteItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the Governance Group. | [required] +**status** | **int** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_delete_item import WorkgroupDeleteItem + +workgroup_delete_item = WorkgroupDeleteItem( +id='464ae7bf791e49fdb74606a2e4a89635', +status=204, +description=' +> Governance Group deleted successfully. + +> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. + +> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDto.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDto.md new file mode 100644 index 000000000..b9f04d527 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDto.md @@ -0,0 +1,47 @@ +--- +id: v2024-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupDto', 'V2024WorkgroupDto'] +slug: /tools/sdk/python/v2024/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'V2024WorkgroupDto'] +--- + +# WorkgroupDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**owner** | [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**id** | **str** | Governance group ID. | [optional] [readonly] +**name** | **str** | Governance group name. | [optional] +**description** | **str** | Governance group description. | [optional] +**member_count** | **int** | Number of members in the governance group. | [optional] [readonly] +**connection_count** | **int** | Number of connections in the governance group. | [optional] [readonly] +**created** | **datetime** | | [optional] +**modified** | **datetime** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_dto import WorkgroupDto + +workgroup_dto = WorkgroupDto( +owner=, +id='2c91808568c529c60168cca6f90c1313', +name='DB Access Governance Group', +description='Description of the Governance Group', +member_count=1641498673000, +connection_count=1641498673000, +created='2022-01-06T19:51:13Z', +modified='2022-01-06T19:51:13Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..89f8a05f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupDtoOwner.md @@ -0,0 +1,41 @@ +--- +id: v2024-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupDtoOwner', 'V2024WorkgroupDtoOwner'] +slug: /tools/sdk/python/v2024/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'V2024WorkgroupDtoOwner'] +--- + +# WorkgroupDtoOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. | [optional] +**display_name** | **str** | The display name of the identity | [optional] [readonly] +**email_address** | **str** | The primary email address of the identity | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_dto_owner import WorkgroupDtoOwner + +workgroup_dto_owner = WorkgroupDtoOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support', +display_name='Support', +email_address='support@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..8f36c324e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,41 @@ +--- +id: v2024-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupMemberAddItem', 'V2024WorkgroupMemberAddItem'] +slug: /tools/sdk/python/v2024/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'V2024WorkgroupMemberAddItem'] +--- + +# WorkgroupMemberAddItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of identity in bulk member add request. | [required] +**status** | **int** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_member_add_item import WorkgroupMemberAddItem + +workgroup_member_add_item = WorkgroupMemberAddItem( +id='464ae7bf791e49fdb74606a2e4a89635', +status=201, +description=' +> Identity is added into Governance Group members list. + +> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..b4e136a4e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,41 @@ +--- +id: v2024-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkgroupMemberDeleteItem', 'V2024WorkgroupMemberDeleteItem'] +slug: /tools/sdk/python/v2024/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'V2024WorkgroupMemberDeleteItem'] +--- + +# WorkgroupMemberDeleteItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of identity in bulk member add /remove request. | [required] +**status** | **int** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | [required] +**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem + +workgroup_member_delete_item = WorkgroupMemberDeleteItem( +id='464ae7bf791e49fdb74606a2e4a89635', +status=204, +description=' +> Identity deleted from Governance Group members list. + +> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md new file mode 100644 index 000000000..e7129b83d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md @@ -0,0 +1,639 @@ +--- +id: access-profiles +title: Access_Profiles +pagination_label: Access_Profiles +sidebar_label: Access_Profiles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Profiles', 'Access_Profiles'] +slug: /tools/sdk/python/v3/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'Access_Profiles', 'Access_Profiles'] +--- + +# sailpoint.v3.AccessProfilesApi + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +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. + +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. + +Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile + + +## create-access-profile +Create Access Profile +Use this API to create an access profile. +A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile | [**AccessProfile**](../models/access-profile) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Access profile created. | AccessProfile | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_access_profile.from_json(access_profile) + results =AccessProfilesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile 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 | Returned when an access profile cannot be deleted as it's being used. | 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 +import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +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 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profiles-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_profile_bulk_delete_request | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | + +### Return type +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse | - | +202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + results =AccessProfilesApi(api_client).delete_access_profiles_in_bulk(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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An AccessProfile | AccessProfile | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the access profile containing the entitlements. + 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, 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. + 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 +import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.entitlement import Entitlement +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Use this API to get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) + +### 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 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. + 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* **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. + 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 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. + Query | include_unsegmented | **bool** | (optional) (default to True) | 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. + +### Return type +[**List[AccessProfile]**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access profiles. | List[AccessProfile] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Access Profile to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Access Profile as updated. | AccessProfile | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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 + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =AccessProfilesApi(api_client).patch_access_profile(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md new file mode 100644 index 000000000..e2de1389e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -0,0 +1,450 @@ +--- +id: access-request-approvals +title: Access_Request_Approvals +pagination_label: Access_Request_Approvals +sidebar_label: Access_Request_Approvals +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Request_Approvals', 'Access_Request_Approvals'] +slug: /tools/sdk/python/v3/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'Access_Request_Approvals', 'Access_Request_Approvals'] +--- + +# sailpoint.v3.AccessRequestApprovalsApi + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-completed-approvals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | comment_dto | [**CommentDto**](../models/comment-dto) | (optional) | Reviewer's comment. + +### 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/forward-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | forward_approval_dto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. + +### 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_forward_approval_dto.from_json(forward_approval_dto) + results =AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-approval-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + Query | from_date | **str** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + +### Return type +[**ApprovalSummary**](../models/approval-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary | - | +400 | Client Error - Returned if the query parameter 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-completed-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + 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, 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* + 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: **created, modified** + +### Return type +[**List[CompletedApproval]**](../models/completed-approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Completed Approvals. | List[CompletedApproval] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-pending-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | 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. + 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *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: **created, modified** + +### Return type +[**List[PendingApproval]**](../models/pending-approval) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Pending Approvals. | List[PendingApproval] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | approval_id | **str** | True | Approval ID. + Body | comment_dto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_comment_dto.from_json(comment_dto) + results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md new file mode 100644 index 000000000..fca89e729 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md @@ -0,0 +1,469 @@ +--- +id: access-requests +title: Access_Requests +pagination_label: Access_Requests +sidebar_label: Access_Requests +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access_Requests', 'Access_Requests'] +slug: /tools/sdk/python/v3/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'Access_Requests', 'Access_Requests'] +--- + +# sailpoint.v3.AccessRequestsApi + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-access-request**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request +[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status +[**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | cancel_access_request | [**CancelAccessRequest**](../models/cancel-access-request) | 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_cancel_access_request.from_json(cancel_access_request) + results =AccessRequestsApi(api_client).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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. +These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request | [**AccessRequest**](../models/access-request) | True | + +### Return type +[**AccessRequestResponse**](../models/access-request-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Access Request Response. | AccessRequestResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_access_request.from_json(access_request) + results =AccessRequestsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Access Request Configuration Details. | AccessRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-request-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + Query | assigned_to | **str** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | count | **bool** | (optional) (default to False) | 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. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. + Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, 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: **created, modified, accountActivityItemId, name** + Query | request_state | **str** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**List[RequestedItemStatus]**](../models/requested-item-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of requested item statuses. | List[RequestedItemStatus] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-access-request-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | access_request_config | [**AccessRequestConfig**](../models/access-request-config) | True | + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Access Request Configuration Details. | AccessRequestConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_access_request_config.from_json(access_request_config) + results =AccessRequestsApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md new file mode 100644 index 000000000..b36ebc19c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md @@ -0,0 +1,189 @@ +--- +id: account-activities +title: Account_Activities +pagination_label: Account_Activities +sidebar_label: Account_Activities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Activities', 'Account_Activities'] +slug: /tools/sdk/python/v3/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'Account_Activities', 'Account_Activities'] +--- + +# sailpoint.v3.AccountActivitiesApi + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity +[**list-account-activities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + + +## get-account-activity +Get an Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-activity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account activity id + +### Return type +[**AccountActivity**](../models/account-activity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An account activity object | AccountActivity | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-account-activities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | requested_by | **str** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | regarding_identity | **str** | (optional) | 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*. + 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: **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* + 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: **type, created, modified** + +### Return type +[**List[AccountActivity]**](../models/account-activity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of account activities | List[AccountActivity] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md new file mode 100644 index 000000000..4c1b1fe02 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md @@ -0,0 +1,92 @@ +--- +id: account-usages +title: Account_Usages +pagination_label: Account_Usages +sidebar_label: Account_Usages +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account_Usages', 'Account_Usages'] +slug: /tools/sdk/python/v3/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'Account_Usages', 'Account_Usages'] +--- + +# sailpoint.v3.AccountUsagesApi + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-account-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | account_id | **str** | True | ID of IDN account + 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 | 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: **date** + +### Return type +[**List[AccountUsage]**](../models/account-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of account usage insights for past 12 months. | List[AccountUsage] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md new file mode 100644 index 000000000..7a5fced9d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md @@ -0,0 +1,812 @@ +--- +id: accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Accounts', 'Accounts'] +slug: /tools/sdk/python/v3/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'Accounts'] +--- + +# sailpoint.v3.AccountsApi + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **POST** `/accounts` | Create Account +[**delete-account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account +[**disable-account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account +[**enable-account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account +[**get-account**](#get-account) | **GET** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **GET** `/accounts` | Accounts List +[**put-account**](#put-account) | **PUT** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + + +## create-account +Create Account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | account_attributes_create | [**AccountAttributesCreate**](../models/account-attributes-create) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_account_attributes_create.from_json(account_attributes_create) + results =AccountsApi(api_client).create_account(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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-account +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## disable-account +Disable Account +This API submits a task to disable the account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/disable-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + Body | account_toggle_request | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_account_toggle_request.from_json(account_toggle_request) + results =AccountsApi(api_client).disable_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## enable-account +Enable Account +This API submits a task to enable account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/enable-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + Body | account_toggle_request | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_account_toggle_request.from_json(account_toggle_request) + results =AccountsApi(api_client).enable_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-account +Account Details +Use this API to return the details for a single account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + +### Return type +[**Account**](../models/account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Account object. | Account | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.account import Account +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-account-entitlements +Account Entitlements +This API returns entitlements of the account. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + 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[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An array of account 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 | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.entitlement import Entitlement +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-accounts +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-accounts) + +### 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 | detail_level | **str** | (optional) | 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. + 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, 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* + 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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + +### Return type +[**List[Account]**](../models/account) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of account objects. | List[Account] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.account import Account +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-account +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + Body | account_attributes | [**AccountAttributes**](../models/account-attributes) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details. | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_account_attributes.from_json(account_attributes) + results =AccountsApi(api_client).put_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-reload-account +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reload-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account id + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## unlock-account +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/unlock-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The account ID. + Body | account_unlock_request | [**AccountUnlockRequest**](../models/account-unlock-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Async task details | AccountsAsyncResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_account_unlock_request.from_json(account_unlock_request) + results =AccountsApi(api_client).unlock_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-account +Update Account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-account) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Account ID. + Body | request_body | **[]object** | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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. + 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() + new_request_body.from_json(request_body) + results =AccountsApi(api_client).update_account(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md new file mode 100644 index 000000000..5035eb276 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md @@ -0,0 +1,209 @@ +--- +id: application-discovery +title: Application_Discovery +pagination_label: Application_Discovery +sidebar_label: Application_Discovery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Application_Discovery', 'Application_Discovery'] +slug: /tools/sdk/python/v3/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'Application_Discovery', 'Application_Discovery'] +--- + +# sailpoint.v3.ApplicationDiscoveryApi + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-applications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-applications +Get Discovered Applications for Tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-discovered-applications) + +### 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 | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + Query | filter | **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**: *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* + 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, description, discoveredAt, discoverySource** + +### Return type +[**List[GetDiscoveredApplications200ResponseInner]**](../models/get-discovered-applications200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | List[GetDiscoveredApplications200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-manual-discover-applications-csv-template) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate | - | +400 | Client Error - 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**: text/csv, application/json + +### Example + +```python +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-manual-discover-applications-csv-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | file | **bytearray** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The CSV has been successfully processed. | | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md new file mode 100644 index 000000000..8c982e259 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md @@ -0,0 +1,162 @@ +--- +id: auth-users +title: Auth_Users +pagination_label: Auth_Users +sidebar_label: Auth_Users +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Auth_Users', 'Auth_Users'] +slug: /tools/sdk/python/v3/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'Auth_Users', 'Auth_Users'] +--- + +# sailpoint.v3.AuthUsersApi + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-auth-user**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details +[**patch-auth-user**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update + + +## get-auth-user +Auth User Details +Return the specified user's authentication system details. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-user) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity ID + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The specified user's authentication system details. | AuthUser | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-user +Auth User Update +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-user) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Identity ID + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth user updated. | AuthUser | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =AuthUsersApi(api_client).patch_auth_user(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md new file mode 100644 index 000000000..17401a5f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md @@ -0,0 +1,352 @@ +--- +id: branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Branding', 'Branding'] +slug: /tools/sdk/python/v3/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'Branding'] +--- + +# sailpoint.v3.BrandingApi + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-branding-item**](#create-branding-item) | **POST** `/brandings` | Create a branding item +[**delete-branding**](#delete-branding) | **DELETE** `/brandings/{name}` | Delete a branding item +[**get-branding**](#get-branding) | **GET** `/brandings/{name}` | Get a branding item +[**get-branding-list**](#get-branding-list) | **GET** `/brandings` | List of branding items +[**set-branding-item**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item + + +## create-branding-item +Create a branding item +This API endpoint creates a branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-branding-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | name | **str** | True | name of branding item + | product_name | **str** | True | product name + | action_button_color | **str** | (optional) | hex value of color for action button + | active_link_color | **str** | (optional) | hex value of color for link + | navigation_color | **str** | (optional) | hex value of color for navigation bar + | email_from_address | **str** | (optional) | email from address + | login_informational_message | **str** | (optional) | login information message + | file_standard | **bytearray** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Branding item created | BrandingItem | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.branding_item import BrandingItem +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-branding +Delete a branding item +This API endpoint delete information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-branding) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The name of the branding item to be deleted + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-branding +Get a branding item +This API endpoint retrieves information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The name of the branding item to be retrieved + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A branding item object | BrandingItem | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.branding_item import BrandingItem +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-branding-list +List of branding items +This API endpoint returns a list of branding items. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding-list) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[BrandingItem]**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of branding items. | List[BrandingItem] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.branding_item import BrandingItem +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-branding-item +Update a branding item +This API endpoint updates information for an existing branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-branding-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | The name of the branding item to be retrieved + | name2 | **str** | True | name of branding item + | product_name | **str** | True | product name + | action_button_color | **str** | (optional) | hex value of color for action button + | active_link_color | **str** | (optional) | hex value of color for link + | navigation_color | **str** | (optional) | hex value of color for navigation bar + | email_from_address | **str** | (optional) | email from address + | login_informational_message | **str** | (optional) | login information message + | file_standard | **bytearray** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Branding item updated | BrandingItem | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.branding_item import BrandingItem +from pprint import pprint +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, name2, 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") + pprint(results) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md new file mode 100644 index 000000000..61f496a54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md @@ -0,0 +1,392 @@ +--- +id: certification-campaign-filters +title: Certification_Campaign_Filters +pagination_label: Certification_Campaign_Filters +sidebar_label: Certification_Campaign_Filters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Campaign_Filters', 'Certification_Campaign_Filters'] +slug: /tools/sdk/python/v3/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'Certification_Campaign_Filters', 'Certification_Campaign_Filters'] +--- + +# sailpoint.v3.CertificationCampaignFiltersApi + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-campaign-filter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter +[**delete-campaign-filters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**list-campaign-filters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters +[**update-campaign-filter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter + + +## create-campaign-filter +Create Campaign Filter +Use this API to create a campaign filter based on filter details and criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_filter_details | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignFilterDetails | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_campaign_filter_details.from_json(campaign_filter_details) + results =CertificationCampaignFiltersApi(api_client).create_campaign_filter(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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-campaign-filters +Deletes Campaign Filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-filters) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | True | A json list of IDs of campaign filters 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**: application/json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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. + 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() + new_request_body.from_json(request_body) + CertificationCampaignFiltersApi(api_client).delete_campaign_filters(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) +``` + + + +[[Back to top]](#) + +## get-campaign-filter-by-id +Get Campaign Filter by ID +Retrieves information for an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-filter-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the campaign filter to be retrieved. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A campaign filter object. | CampaignFilterDetails | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-campaign-filters +List Campaign Filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-campaign-filters) + +### 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 | start | **int** | (optional) (default to 0) | 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. + Query | include_system_filters | **bool** | (optional) (default to True) | 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. + +### Return type +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of campaign filter objects. | ListCampaignFilters200Response | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-campaign-filter +Updates a Campaign Filter +Updates an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | filter_id | **str** | True | The ID of the campaign filter being modified. + Body | campaign_filter_details | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | A campaign filter details with updated field values. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignFilterDetails | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_campaign_filter_details.from_json(campaign_filter_details) + results =CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md new file mode 100644 index 000000000..065b5f464 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md @@ -0,0 +1,1772 @@ +--- +id: certification-campaigns +title: Certification_Campaigns +pagination_label: Certification_Campaigns +sidebar_label: Certification_Campaigns +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Campaigns', 'Certification_Campaigns'] +slug: /tools/sdk/python/v3/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'Certification_Campaigns', 'Certification_Campaigns'] +--- + +# sailpoint.v3.CertificationCampaignsApi + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign +[**create-campaign-template**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Campaign ID. + Body | campaign_complete_options | [**CampaignCompleteOptions**](../models/campaign-complete-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +### 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-campaign +Create a campaign +Use this API to create a certification campaign with the information provided in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign | [**Campaign**](../models/campaign) | True | + +### Return type +[**Campaign**](../models/campaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.campaign import Campaign +from pprint import pprint +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() + new_campaign.from_json(campaign) + results =CertificationCampaignsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-campaign-template +Create a Campaign Template +Use this API to create a certification campaign template based on campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_template | [**CampaignTemplate**](../models/campaign-template) | True | + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created successfully. | CampaignTemplate | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_campaign_template.from_json(campaign_template) + results =CertificationCampaignsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-campaign-template +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being deleted. + +### 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 | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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 +import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-campaign-template-schedule +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template whose schedule is being deleted. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-campaigns +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaigns) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaigns_delete_request | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | True | IDs of the campaigns to delete. + +### 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_campaigns_delete_request.from_json(campaigns_delete_request) + results =CertificationCampaignsApi(api_client).delete_campaigns(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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-active-campaigns +List Campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + 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, sw* **status**: *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, created** + +### Return type +[**List[GetActiveCampaigns200ResponseInner]**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of campaign objects. By default list of SLIM campaigns is returned. | List[GetActiveCampaigns200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign to be retrieved. + Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + +### Return type +[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-reports +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign whose reports are being fetched. + +### Return type +[**List[CampaignReport]**](../models/campaign-report) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Array of campaign report objects. | List[CampaignReport] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-reports-config +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Campaign report configuration. | CampaignReportsConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-template +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Requested campaign template's ID. + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Data for the campaign matching the given ID. | CampaignTemplate | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-template-schedule +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template whose schedule is being fetched. + +### Return type +[**Schedule**](../models/schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) for more examples. | Schedule | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.schedule import Schedule +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-campaign-templates +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-templates) + +### 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 | 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 | 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**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + +### Return type +[**List[CampaignTemplate]**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of campaign template objects. | List[CampaignTemplate] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +``` + + + +[[Back to top]](#) + +## move +Reassign Certifications +This API reassigns the specified certifications from one identity to another. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/move) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification campaign ID + Body | admin_review_reassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The reassign task that has been submitted. | CertificationTask | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_admin_review_reassign.from_json(admin_review_reassign) + results =CertificationCampaignsApi(api_client).move(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-campaign-template +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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) + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =CertificationCampaignsApi(api_client).patch_campaign_template(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-campaign-reports-config +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | campaign_reports_config | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted campaign report configuration. | CampaignReportsConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_campaign_reports_config.from_json(campaign_reports_config) + results =CertificationCampaignsApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-campaign-template-schedule +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being scheduled. + Body | schedule | [**Schedule**](../models/schedule) | (optional) | + +### 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 | - | +400 | Client Error - Returned if the request body is invalid. | 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 +import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.schedule import Schedule +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## start-campaign +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Campaign ID. + Body | activate_campaign_options | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | 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. + +### 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-campaign-remediation-scan +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign the remediation scan is being run for. + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-campaign-report +Run Campaign Report +Use this API to run a report for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign the report is being run for. +Path | type | [**ReportType**](../models/report-type) | True | Type of the report to run. + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-generate-campaign-template +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template to use for generation. + +### Return type +[**CampaignReference**](../models/campaign-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-campaign +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the campaign template being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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 + +### Return type +[**SlimCampaign**](../models/slim-campaign) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | SlimCampaign | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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() + new_json_patch_operation.from_json(json_patch_operation) + results =CertificationCampaignsApi(api_client).update_campaign(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md new file mode 100644 index 000000000..0eac28ad5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md @@ -0,0 +1,305 @@ +--- +id: certification-summaries +title: Certification_Summaries +pagination_label: Certification_Summaries +sidebar_label: Certification_Summaries +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification_Summaries', 'Certification_Summaries'] +slug: /tools/sdk/python/v3/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'Certification_Summaries', 'Certification_Summaries'] +--- + +# sailpoint.v3.CertificationSummariesApi + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-access-summaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**get-identity-summaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**get-identity-summary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + + +## get-identity-access-summaries +Access Summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-access-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID +Path | type | **str** | True | The type of access review item to retrieve summaries for + 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, 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: **access.name** + +### Return type +[**List[AccessSummary]**](../models/access-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of access summaries | List[AccessSummary] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-decision-summary +Summary of Certification Decisions +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-decision-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification ID + 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: **identitySummary.id**: *eq, in* + +### Return type +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of the decisions made | IdentityCertDecisionSummary | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-summaries +Identity Summaries for Campaign Certification +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summaries) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + 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* **completed**: *eq, ne* **name**: *eq, 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[CertificationIdentitySummary]**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity summaries | List[CertificationIdentitySummary] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-summary +Summary for Identity +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID +Path | identity_summary_id | **str** | True | The identity summary ID + +### Return type +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity summary | CertificationIdentitySummary | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md new file mode 100644 index 000000000..62aa2b666 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md @@ -0,0 +1,818 @@ +--- +id: certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certifications', 'Certifications'] +slug: /tools/sdk/python/v3/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'Certifications'] +--- + +# sailpoint.v3.CertificationsApi + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-certification-task**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID +[**get-identity-certification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items +[**list-identity-certifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications +[**make-identity-decision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-certification-task +Certification Task by ID +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-certification-task) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The task ID + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A certification task | CertificationTask | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.certification_task import CertificationTask +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-certification +Identity Certification by ID +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification id + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification object | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-certification-item-permissions +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification-item-permissions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | certification_id | **str** | True | The certification ID +Path | item_id | **str** | True | The certification item ID + 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: **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 + 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[PermissionDto]**](../models/permission-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of permissions associated with the given itemId | List[PermissionDto] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.permission_dto import PermissionDto +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-pending-certification-tasks +List of Pending Certification Tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-pending-certification-tasks) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | reviewer_identity | **str** | (optional) | The ID of reviewer identity. *me* indicates the current user. + 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* **targetId**: *eq, in* **type**: *eq, in* + +### Return type +[**List[CertificationTask]**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of pending certification tasks | List[CertificationTask] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.certification_task import CertificationTask +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-certification-reviewers +List of Reviewers for certification +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-certification-reviewers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The certification ID + 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, sw* **email**: *eq, 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, email** + +### Return type +[**List[IdentityReferenceWithNameAndEmail]**](../models/identity-reference-with-name-and-email) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of reviewers | List[IdentityReferenceWithNameAndEmail] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-access-review-items +List of Access Review Items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-access-review-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + 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* **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* + 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + Query | entitlements | **str** | (optional) | 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. + Query | access_profiles | **str** | (optional) | 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. + Query | roles | **str** | (optional) | 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. + +### Return type +[**List[AccessReviewItem]**](../models/access-review-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of access review items | List[AccessReviewItem] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-certifications +List Identity Campaign Certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-certifications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | reviewer_identity | **str** | (optional) | Reviewer's identity. *me* indicates the current user. + 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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, due, signed** + +### Return type +[**List[IdentityCertificationDto]**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity campaign certifications. | List[IdentityCertificationDto] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## make-identity-decision +Decide on a Certification Item +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/make-identity-decision) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the identity campaign certification on which to make decisions + Body | review_decision | [**[]ReviewDecision**](../models/review-decision) | True | A non-empty array of decisions to be made. + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification object | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + + try: + # Decide on a Certification Item + new_review_decision = ReviewDecision() + new_review_decision.from_json(review_decision) + results =CertificationsApi(api_client).make_identity_decision(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reassign-identity-certifications +Reassign Identities or Items +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reassign-identity-certifications) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + Body | review_reassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification details after completing the reassignment. | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_review_reassign.from_json(review_reassign) + results =CertificationsApi(api_client).reassign_identity_certifications(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sign-off-identity-certification +Finalize Identity Certification Decisions +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/sign-off-identity-certification) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An identity campaign certification object | IdentityCertificationDto | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-reassign-certs-async +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reassign-certs-async) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The identity campaign certification ID + Body | review_reassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A certification task object for the reassignment which can be queried for status. | CertificationTask | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_review_reassign.from_json(review_reassign) + results =CertificationsApi(api_client).submit_reassign_certs_async(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md new file mode 100644 index 000000000..133b3aabb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md @@ -0,0 +1,644 @@ +--- +id: configuration-hub +title: Configuration_Hub +pagination_label: Configuration_Hub +sidebar_label: Configuration_Hub +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Configuration_Hub', 'Configuration_Hub'] +slug: /tools/sdk/python/v3/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'Configuration_Hub', 'Configuration_Hub'] +--- + +# sailpoint.v3.ConfigurationHubApi + Upload configurations and manage object mappings between tenants. + +Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. + +The function of object mapping allows objects with varying names and IDs to be compared. While objects are compared, a user can replace a value in the source tenant with a new value. Object mapping also helps in locating referenced objects to the source object during the drafting process. + +Refer to [Uploading a Configuration File](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#uploading-a-configuration-file) for more information about uploading Configuration Files + +Refer to [Mapping Objects](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#mapping-objects) for more information about object mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-object-mapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**create-object-mappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**create-uploaded-configuration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration +[**delete-object-mapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**get-object-mappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**get-uploaded-configuration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**list-uploaded-configurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**update-object-mappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + + +## create-object-mapping +Creates an object mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + Body | object_mapping_request | [**ObjectMappingRequest**](../models/object-mapping-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingResponse**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The created object mapping between current org and source org. | ObjectMappingResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_object_mapping_request.from_json(object_mapping_request) + results =ConfigurationHubApi(api_client).create_object_mapping(source_org, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-object-mappings +Bulk creates object mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mappings) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + Body | object_mapping_bulk_create_request | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | True | The bulk create object mapping request body. + +### Return type +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The created object mapping between current org and source org. | ObjectMappingBulkCreateResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + results =ConfigurationHubApi(api_client).create_object_mappings(source_org, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-uploaded-configuration +Upload a Configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-uploaded-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | data | **bytearray** | True | JSON file containing the objects to be imported. + | name | **str** | True | Name that will be assigned to the uploaded configuration file. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Upload job accepted and queued for processing. | BackupResponse | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-object-mapping +Deletes an object mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-object-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. +Path | object_mapping_id | **str** | True | The id of the object mapping to be deleted. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-uploaded-configuration +Delete an Uploaded Configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-uploaded-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the uploaded configuration. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-object-mappings +Gets list of object mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-object-mappings) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + +### Return type +[**List[ObjectMappingResponse]**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing object mappings between current org and source org. | List[ObjectMappingResponse] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-uploaded-configuration +Get an Uploaded Configuration +This API gets an existing uploaded configuration for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-uploaded-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the uploaded configuration. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Gets an uploaded configuration details. | BackupResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-uploaded-configurations +List Uploaded Configurations +This API gets a list of existing uploaded configurations for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-uploaded-configurations) + +### 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: **status**: *eq* + +### Return type +[**List[BackupResponse]**](../models/backup-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of existing uploaded configurations. | List[BackupResponse] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-object-mappings +Bulk updates object mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-object-mappings) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_org | **str** | True | The name of the source org. + Body | object_mapping_bulk_patch_request | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The updated object mappings. | ObjectMappingBulkPatchResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + results =ConfigurationHubApi(api_client).update_object_mappings(source_org, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md new file mode 100644 index 000000000..becd475bb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md @@ -0,0 +1,748 @@ +--- +id: connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Connectors', 'Connectors'] +slug: /tools/sdk/python/v3/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'Connectors'] +--- + +# sailpoint.v3.ConnectorsApi + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-connector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector +[**delete-custom-connector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name +[**get-connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name +[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get Connector List +[**get-connector-source-config**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**get-connector-source-template**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**get-connector-translations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**put-connector-source-config**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**put-connector-source-template**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**put-connector-translations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**update-connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name + + +## create-custom-connector +Create Custom Connector +Create custom connector. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-custom-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | v3_create_connector_dto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True | + +### Return type +[**V3ConnectorDto**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | V3ConnectorDto | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_v3_create_connector_dto.from_json(v3_create_connector_dto) + results =ConnectorsApi(api_client).create_custom_connector(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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-custom-connector +Delete Connector by Script Name +Delete a custom connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-custom-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-connector +Get Connector by Script Name +Fetches a connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | ConnectorDetail | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.connector_detail import ConnectorDetail +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-list) + +### 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + 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 | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**List[V3ConnectorDto]**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A Connector Dto object | List[V3ConnectorDto] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-source-config +Get Connector Source Configuration +Fetches a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's source template | 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**: application/xml, application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-source-template +Get Connector Source Template +Fetches a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's source template | 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**: application/xml, application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-connector-translations +Get Connector Translations +Fetches a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-translations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | locale | **str** | True | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's translations | 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 +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-source-config +Update Connector Source Configuration +Update a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | file | **bytearray** | True | connector source config xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.update_detail import UpdateDetail +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-source-template +Update Connector Source Template +Update a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | file | **bytearray** | True | connector source template xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.update_detail import UpdateDetail +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-connector-translations +Update Connector Translations +Update a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-translations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | locale | **str** | True | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The connector's update detail | UpdateDetail | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.update_detail import UpdateDetail +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-connector +Update Connector by Script Name +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 + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-connector) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A updated Connector Dto object | ConnectorDetail | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + + try: + # Update Connector by Script Name + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =ConnectorsApi(api_client).update_connector(script_name, 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") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md new file mode 100644 index 000000000..c136ceb24 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md @@ -0,0 +1,596 @@ +--- +id: global-tenant-security-settings +title: Global_Tenant_Security_Settings +pagination_label: Global_Tenant_Security_Settings +sidebar_label: Global_Tenant_Security_Settings +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Global_Tenant_Security_Settings', 'Global_Tenant_Security_Settings'] +slug: /tools/sdk/python/v3/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'Global_Tenant_Security_Settings', 'Global_Tenant_Security_Settings'] +--- + +# sailpoint.v3.GlobalTenantSecuritySettingsApi + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-auth-org-network-config**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-network-config**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**patch-auth-org-network-config**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration + + +## create-auth-org-network-config +Create security network configuration. +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-auth-org-network-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | network_configuration | [**NetworkConfiguration**](../models/network-configuration) | True | 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. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Network configuration for the tenant. | NetworkConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_network_configuration.from_json(network_configuration) + results =GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-lockout-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-network-config +Get security network configuration. +This API returns the details of an org's network auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-network-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Network configuration for the tenant's auth org. | NetworkConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-service-provider-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-session-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Session configuration for the tenant's auth org. | SessionConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-lockout-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org lockout configuration. | LockoutConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-network-config +Update security network configuration. +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-network-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org network configuration. | NetworkConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-service-provider-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-session-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org session configuration. | SessionConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{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.` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(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") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md new file mode 100644 index 000000000..75cb5e773 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md @@ -0,0 +1,879 @@ +--- +id: identity-profiles +title: Identity_Profiles +pagination_label: Identity_Profiles +sidebar_label: Identity_Profiles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity_Profiles', 'Identity_Profiles'] +slug: /tools/sdk/python/v3/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'Identity_Profiles', 'Identity_Profiles'] +--- + +# sailpoint.v3.IdentityProfilesApi + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**show-identity-preview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**sync-identity-profile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Creates an identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_profile | [**IdentityProfile**](../models/identity-profile) | True | + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created identity profile. | IdentityProfile | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_identity_profile.from_json(identity_profile) + results =IdentityProfilesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +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 + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | request_body | **[]str** | True | Identity Profile bulk delete request body. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + + try: + # Delete Identity Profiles + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =IdentityProfilesApi(api_client).delete_identity_profiles(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-identity-profiles) + +### 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, ne* **name**: *eq, ne* **priority**: *eq, ne* + 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, priority** + +### Return type +[**List[IdentityProfileExportedObject]**](../models/identity-profile-exported-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of export objects with identity profiles. | List[IdentityProfileExportedObject] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-default-identity-attribute-config +Get default Identity Attribute Config +This returns the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-identity-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | The Identity Profile ID. + +### Return type +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An Identity Attribute Config object. | IdentityAttributeConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Identity profile object. | IdentityProfile | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-identity-profiles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_profile_exported_object | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. + +### Return type +[**ObjectImportResult**](../models/object-import-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of importing Identity Profiles. | ObjectImportResult | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [sailpoint.v3.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject() + new_identity_profile_exported_object.from_json(identity_profile_exported_object) + results =IdentityProfilesApi(api_client).import_identity_profiles(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles) + +### 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + 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, priority, created, modified, owner.id, owner.name** + +### Return type +[**List[IdentityProfile]**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of identity profiles. | List[IdentityProfile] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## show-identity-preview +Generate Identity Profile Preview +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/show-identity-preview) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. + +### Return type +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_identity_preview_request.from_json(identity_preview_request) + results =IdentityProfilesApi(api_client).show_identity_preview(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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e) +``` + + + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/sync-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | The Identity Profile ID to be processed + +### 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated identity profile. | IdentityProfile | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/Index.md b/docs/tools/sdk/python/Reference/V3/Methods/Index.md new file mode 100644 index 000000000..08320e15d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['python', 'Python', 'sdk', 'methods'] +slug: /tools/sdk/python/v3/methods +tags: ['SDK', 'Software Development Kit', 'v3', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **V3** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md new file mode 100644 index 000000000..4677213a2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md @@ -0,0 +1,478 @@ +--- +id: lifecycle-states +title: Lifecycle_States +pagination_label: Lifecycle_States +sidebar_label: Lifecycle_States +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Lifecycle_States', 'Lifecycle_States'] +slug: /tools/sdk/python/v3/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'Lifecycle_States', 'Lifecycle_States'] +--- + +# sailpoint.v3.LifecycleStatesApi + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-lifecycle-state**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**delete-lifecycle-state**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**get-lifecycle-state**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**get-lifecycle-states**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**set-lifecycle-state**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## create-lifecycle-state +Create Lifecycle State +Use this endpoint to create a lifecycle state. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + Body | lifecycle_state | [**LifecycleState**](../models/lifecycle-state) | True | Lifecycle state to be created. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created LifecycleState object. | LifecycleState | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_lifecycle_state.from_json(lifecycle_state) + results =LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-lifecycle-state +Delete Lifecycle State +Use this endpoint to delete the lifecycle state by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle state ID. + +### Return type +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The request was successfully accepted into the system. | LifecyclestateDeleted | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-lifecycle-state +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle state ID. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested LifecycleState was successfully retrieved. | LifecycleState | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-lifecycle-states +Lists LifecycleStates +Use this endpoint to list all lifecycle states by their associated identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-states) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. + 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 | 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: **created, modified** + +### Return type +[**List[LifecycleState]**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of LifecycleState objects. | List[LifecycleState] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-lifecycle-state +Set Lifecycle State +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-lifecycle-state) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_id | **str** | True | ID of the identity to update. + Body | set_lifecycle_state_request | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | True | + +### Return type +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The request was successfully accepted into the system. | SetLifecycleState200Response | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_set_lifecycle_state_request.from_json(set_lifecycle_state_request) + results =LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-lifecycle-states) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | identity_profile_id | **str** | True | Identity profile ID. +Path | lifecycle_state_id | **str** | True | Lifecycle state ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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 + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The LifecycleState was successfully updated. | LifecycleState | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md new file mode 100644 index 000000000..87cd3a236 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md @@ -0,0 +1,518 @@ +--- +id: mfa-configuration +title: MFA_Configuration +pagination_label: MFA_Configuration +sidebar_label: MFA_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MFA_Configuration', 'MFA_Configuration'] +slug: /tools/sdk/python/v3/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFA_Configuration', 'MFA_Configuration'] +--- + +# sailpoint.v3.MFAConfigurationApi + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + + +## delete-mfa-config +Delete MFA method configuration +This API removes the configuration for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-mfa-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an MFA method. | MfaOktaConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-duo-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration of an Duo MFA method. | MfaDuoConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-kba-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | all_languages | **bool** | (optional) | 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 + +### Return type +[**List[KbaQuestion]**](../models/kba-question) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration for KBA MFA method. | List[KbaQuestion] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-okta-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The configuration of an Okta MFA method. | MfaOktaConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-duo-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | mfa_duo_config | [**MfaDuoConfig**](../models/mfa-duo-config) | True | + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an Duo MFA method. | MfaDuoConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_mfa_duo_config.from_json(mfa_duo_config) + results =MFAConfigurationApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-okta-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | mfa_okta_config | [**MfaOktaConfig**](../models/mfa-okta-config) | True | + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA configuration of an Okta MFA method. | MfaOktaConfig | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_mfa_okta_config.from_json(mfa_okta_config) + results =MFAConfigurationApi(api_client).set_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfakba-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | kba_answer_request_item | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**List[KbaAnswerResponseItem]**](../models/kba-answer-response-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The new KBA configuration for the user. | List[KbaAnswerResponseItem] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAConfigurationApi(api_client).set_mfakba_config(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-mfa-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md b/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md new file mode 100644 index 000000000..0b7f018d9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md @@ -0,0 +1,414 @@ +--- +id: mfa-controller +title: MFA_Controller +pagination_label: MFA_Controller +sidebar_label: MFA_Controller +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MFA_Controller', 'MFA_Controller'] +slug: /tools/sdk/python/v3/methods/mfa-controller +tags: ['SDK', 'Software Development Kit', 'MFA_Controller', 'MFA_Controller'] +--- + +# sailpoint.v3.MFAControllerApi + This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-send-token**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token +[**ping-verification-status**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest +[**send-duo-verify-request**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method +[**send-kba-answers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method +[**send-okta-verify-request**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method +[**send-token-auth-request**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method + + +## create-send-token +Create and send user token +This API send token request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-send-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | send_token_request | [**SendTokenRequest**](../models/send-token-request) | True | + +### Return type +[**SendTokenResponse**](../models/send-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Token send status. | SendTokenResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_send_token_request.from_json(send_token_request) + results =MFAControllerApi(api_client).create_send_token(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## ping-verification-status +Polling MFA method by VerificationPollRequest +This API poll the VerificationPollRequest for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/ping-verification-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | method | **str** | True | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + Body | verification_poll_request | [**VerificationPollRequest**](../models/verification-poll-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MFA VerificationPollRequest status an MFA method. | VerificationResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_verification_poll_request.from_json(verification_poll_request) + results =MFAControllerApi(api_client).ping_verification_status(method, 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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-duo-verify-request +Verifying authentication via Duo method +This API Authenticates the user via Duo-Web MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-duo-verify-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | duo_verification_request | [**DuoVerificationRequest**](../models/duo-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The status of verification request. | VerificationResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_duo_verification_request.from_json(duo_verification_request) + results =MFAControllerApi(api_client).send_duo_verify_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-kba-answers +Authenticate KBA provided MFA method +This API Authenticate user in KBA MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-kba-answers) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | kba_answer_request_item | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAuthResponse**](../models/kba-auth-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | KBA authenticated status. | KbaAuthResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + + try: + # Authenticate KBA provided MFA method + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAControllerApi(api_client).send_kba_answers(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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-okta-verify-request +Verifying authentication via Okta method +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-okta-verify-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | okta_verification_request | [**OktaVerificationRequest**](../models/okta-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The status of verification request. | VerificationResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_okta_verification_request.from_json(okta_verification_request) + results =MFAControllerApi(api_client).send_okta_verify_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-token-auth-request +Authenticate Token provided MFA method +This API Authenticate user in Token MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-token-auth-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | token_auth_request | [**TokenAuthRequest**](../models/token-auth-request) | True | + +### Return type +[**TokenAuthResponse**](../models/token-auth-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Token authenticated status. | TokenAuthResponse | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_token_auth_request.from_json(token_auth_request) + results =MFAControllerApi(api_client).send_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") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md new file mode 100644 index 000000000..617d5461b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md @@ -0,0 +1,410 @@ +--- +id: managed-clients +title: Managed_Clients +pagination_label: Managed_Clients +sidebar_label: Managed_Clients +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Managed_Clients', 'Managed_Clients'] +slug: /tools/sdk/python/v3/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'Managed_Clients', 'Managed_Clients'] +--- + +# sailpoint.v3.ManagedClientsApi + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-client**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client +[**delete-managed-client**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client +[**get-managed-client**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client +[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status +[**get-managed-clients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients +[**update-managed-client**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client + + +## create-managed-client +Create Managed Client +Create a new managed client. +The API returns a result that includes the managed client ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | managed_client_request | [**ManagedClientRequest**](../models/managed-client-request) | True | + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created managed client. | ManagedClient | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_managed_client_request.from_json(managed_client_request) + results =ManagedClientsApi(api_client).create_managed_client(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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-managed-client +Delete Managed Client +Delete an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-managed-client +Get Managed Client +Get managed client by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Managed client response. | ManagedClient | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-client-status +Get Managed Client Status +Get a managed client's status, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID to get status for. + Query | type | [**ManagedClientType**](../models/managed-client-type) | True | Managed client type to get status for. + +### Return type +[**ManagedClientStatus**](../models/managed-client-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with the managed client status, with the given ID and type. | ManagedClientStatus | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-clients +Get Managed Clients +List managed clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clients) + +### 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: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* + +### Return type +[**List[ManagedClient]**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with a list of managed clients, based on the specified query parameters. | List[ManagedClient] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-managed-client +Update Managed Client +Update an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed client ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated managed client. | ManagedClient | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =ManagedClientsApi(api_client).update_managed_client(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md new file mode 100644 index 000000000..0ca834838 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md @@ -0,0 +1,478 @@ +--- +id: managed-clusters +title: Managed_Clusters +pagination_label: Managed_Clusters +sidebar_label: Managed_Clusters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Managed_Clusters', 'Managed_Clusters'] +slug: /tools/sdk/python/v3/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'Managed_Clusters', 'Managed_Clusters'] +--- + +# sailpoint.v3.ManagedClustersApi + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster +[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster + + +## create-managed-cluster +Create Create Managed Cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | managed_cluster_request | [**ManagedClusterRequest**](../models/managed-cluster-request) | True | + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created managed cluster. | ManagedCluster | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_managed_cluster_request.from_json(managed_cluster_request) + results =ManagedClustersApi(api_client).create_managed_cluster(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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-managed-cluster +Delete Managed Cluster +Delete an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed cluster ID. + Query | remove_clients | **bool** | (optional) (default to False) | Flag to determine the need to delete a cluster with clients. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## get-client-log-configuration +Get Managed Cluster Log Configuration +Get a managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-client-log-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of managed cluster to get log configuration for. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Log configuration of managed cluster for given cluster ID. | ClientLogConfiguration | - | +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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-cluster +Get Managed Cluster +Get a managed cluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed cluster ID. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with managed cluster for the given ID. | ManagedCluster | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-managed-clusters +Get Managed Clusters +List current organization's managed clusters, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clusters) + +### 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: **operational**: *eq* + +### Return type +[**List[ManagedCluster]**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with a list of managed clusters. | List[ManagedCluster] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-client-log-configuration +Update Managed Cluster Log Configuration +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-client-log-configuration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the managed cluster to update the log configuration for. + Body | put_client_log_configuration_request | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | True | Client log configuration for the given managed cluster. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Response with updated client log configuration for the given managed cluster. | ClientLogConfiguration | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_put_client_log_configuration_request.from_json(put_client_log_configuration_request) + results =ManagedClustersApi(api_client).put_client_log_configuration(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-managed-cluster +Update Managed Cluster +Update an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-cluster) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Managed cluster ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated managed cluster. | ManagedCluster | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =ManagedClustersApi(api_client).update_managed_cluster(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md new file mode 100644 index 000000000..c659bd450 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -0,0 +1,2185 @@ +--- +id: non-employee-lifecycle-management +title: Non_Employee_Lifecycle_Management +pagination_label: Non_Employee_Lifecycle_Management +sidebar_label: Non_Employee_Lifecycle_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Non_Employee_Lifecycle_Management', 'Non_Employee_Lifecycle_Management'] +slug: /tools/sdk/python/v3/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'Non_Employee_Lifecycle_Management', 'Non_Employee_Lifecycle_Management'] +--- + +# sailpoint.v3.NonEmployeeLifecycleManagementApi + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**delete-non-employee-record**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**delete-non-employee-source**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**export-non-employee-records**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**get-non-employee-approval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail +[**get-non-employee-approval-summary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**get-non-employee-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**get-non-employee-record**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**patch-non-employee-source**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Body | non_employee_approval_decision | [**NonEmployeeApprovalDecision**](../models/non-employee-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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_approval_decision.from_json(non_employee_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request creation object | NonEmployeeRequest | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | non_employee_source_request_body | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. + +### Return type +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_source_request_body.from_json(non_employee_source_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create a new Schema Attribute for Non-Employee Source +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` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | non_employee_schema_attribute_body | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Schema Attribute created. | NonEmployeeSchemaAttribute | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee record id (UUID) + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-records-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | delete_non_employee_records_in_bulk_request | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | True | Non-Employee bulk delete request body. + +### 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee request id in the UUID format + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete a Schema Attribute for Non-Employee Source +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes for Non-Employee Source +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## export-non-employee-records +Exports Non-Employee Records to CSV +This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-records) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported CSV | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## export-non-employee-source-schema-template +Exports Source Schema Template +This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-source-schema-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported Source Schema Template | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-non-employee-approval +Get a non-employee approval item detail +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Query | include_detail | **bool** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + +### Return type +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | requested_for | **str** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + +### Return type +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | summary of non-employee approval requests | NonEmployeeApprovalSummary | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Obtain the status of bulk upload on the source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-bulk-upload-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID (UUID) + +### Return type +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee record id (UUID) + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee record object | 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee request id (UUID) + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request object. | NonEmployeeRequest | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | requested_for | **str** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + +### Return type +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee request summary object. | NonEmployeeRequestSummary | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema Attribute | NonEmployeeSchemaAttribute | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source-schema-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**List[NonEmployeeSchemaAttribute]**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of Schema Attributes | List[NonEmployeeSchemaAttribute] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source Id (UUID) + | data | **bytearray** | True | + +### Return type +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob | - | +400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | 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 +import sailpoint.v3 +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 pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-approvals +Get List of Non-Employee Approval Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-approvals) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | (optional) | The identity for whom the request was made. *me* indicates the current user. + 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: **approvalStatus**: *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: **created, modified** + +### Return type +[**List[NonEmployeeApprovalItem]**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of approval items. | List[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**: Not defined + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-records) + +### 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 | 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + 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: **sourceId**: *eq* + +### Return type +[**List[NonEmployeeRecord]**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee record objects | List[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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-requests) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | requested_for | **str** | True | The identity for whom the request was made. *me* indicates the current user. + 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 | 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + 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: **sourceId**: *eq* + +### Return type +[**List[NonEmployeeRequest]**](../models/non-employee-request) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of non-employee request objects. | List[NonEmployeeRequest] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources) + +### 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 | requested_for | **str** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | non_employee_count | **bool** | (optional) (default to False) | Flag that determines whether the API will return a non-employee count associated with the source. + 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, sourceId** + +### Return type +[**List[NonEmployeeSourceWithNECount]**](../models/non-employee-source-with-ne-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of non-employee sources objects. | List[NonEmployeeSourceWithNECount] | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-employee record id (UUID) + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A patched 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-patch+json + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +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 pprint import pprint +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) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch a Schema Attribute for Non-Employee Source +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-schema-attribute) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | attribute_id | **str** | True | The Schema Attribute Id (UUID) +Path | source_id | **str** | True | The Source id + 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. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute | - | +400 | Client Error - 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 +import sailpoint.v3 +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 pprint import pprint +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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (partial update)
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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, 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") + pprint(results) + 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..bbe83e549 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md @@ -0,0 +1,352 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_create_o_auth_client_request.from_json(create_o_auth_client_request) + results =OAuthClientsApi(api_client).create_oauth_client(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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 + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =OAuthClientsApi(api_client).patch_oauth_client(id, 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") + pprint(results) + 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..2f097be02 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md @@ -0,0 +1,219 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_org_config.from_json(password_org_config) + results =PasswordConfigurationApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_org_config.from_json(password_org_config) + results =PasswordConfigurationApi(api_client).put_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") + pprint(results) + 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..4eafc6eb3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md @@ -0,0 +1,239 @@ +--- +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 +import sailpoint.v3 +from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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..d1df26f6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md @@ -0,0 +1,259 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_info_query_dto.from_json(password_info_query_dto) + results =PasswordManagementApi(api_client).query_password_info(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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_change_request.from_json(password_change_request) + results =PasswordManagementApi(api_client).set_password(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") + pprint(results) + 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..423deb9ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md @@ -0,0 +1,403 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_policy_v3_dto.from_json(password_policy_v3_dto) + results =PasswordPoliciesApi(api_client).create_password_policy(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_policy_v3_dto.from_json(password_policy_v3_dto) + results =PasswordPoliciesApi(api_client).set_password_policy(id, 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") + pprint(results) + 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..14fd199d6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -0,0 +1,374 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_sync_group.from_json(password_sync_group) + results =PasswordSyncGroupsApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_password_sync_group.from_json(password_sync_group) + results =PasswordSyncGroupsApi(api_client).update_password_sync_group(id, 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") + pprint(results) + 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..01c5f4d5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -0,0 +1,290 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_create_personal_access_token_request.from_json(create_personal_access_token_request) + results =PersonalAccessTokensApi(api_client).create_personal_access_token(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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 + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =PersonalAccessTokensApi(api_client).patch_personal_access_token(id, 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") + pprint(results) + 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..3591f81e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md @@ -0,0 +1,94 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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..49a6e051c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md @@ -0,0 +1,162 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_public_identity_config.from_json(public_identity_config) + results =PublicIdentitiesConfigApi(api_client).update_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") + pprint(results) + 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..522fd1e7d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md @@ -0,0 +1,277 @@ +--- +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 +import sailpoint.v3 +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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, ) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_report_details.from_json(report_details) + results =ReportsDataExtractionApi(api_client).start_report(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") + pprint(results) + 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..046bc3b5d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md @@ -0,0 +1,107 @@ +--- +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 +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. + +[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. Support for additional types may be added in the future without notice. + Query | term | **str** | (optional) | 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. + 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. 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. + 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 +import sailpoint.v3 +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 pprint import pprint +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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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) + 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") + pprint(results) + 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..ba53ac347 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md @@ -0,0 +1,699 @@ +--- +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 +import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role import Role +from pprint import pprint +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() + new_role.from_json(role) + results =RolesApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_role_bulk_delete_request.from_json(role_bulk_delete_request) + results =RolesApi(api_client).delete_bulk_roles(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role import Role +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role_identity import RoleIdentity +from pprint import pprint +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, ) + # 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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role import Role +from pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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 + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =RolesApi(api_client).patch_role(id, 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") + pprint(results) + 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..51cc81ddb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md @@ -0,0 +1,1251 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_sod_policy.from_json(sod_policy) + results =SODPoliciesApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, ) + # 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 +import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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() + new_json_patch_operation.from_json(json_patch_operation) + results =SODPoliciesApi(api_client).patch_sod_policy(id, 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_sod_policy_schedule.from_json(sod_policy_schedule) + results =SODPoliciesApi(api_client).put_policy_schedule(id, 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_sod_policy.from_json(sod_policy) + results =SODPoliciesApi(api_client).put_sod_policy(id, 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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..395648557 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md @@ -0,0 +1,176 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_identity_with_new_access.from_json(identity_with_new_access) + results =SODViolationsApi(api_client).start_predict_sod_violations(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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_identity_with_new_access1.from_json(identity_with_new_access1) + results =SODViolationsApi(api_client).start_violation_check(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") + pprint(results) + 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..7f03ac46c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md @@ -0,0 +1,465 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_create_saved_search_request.from_json(create_saved_search_request) + results =SavedSearchApi(api_client).create_saved_search(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_search_arguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id, 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_saved_search.from_json(saved_search) + results =SavedSearchApi(api_client).put_saved_search(id, 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") + pprint(results) + 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..d1e3fd70b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md @@ -0,0 +1,469 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_create_scheduled_search_request.from_json(create_scheduled_search_request) + results =ScheduledSearchApi(api_client).create_scheduled_search(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_typed_reference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, 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 +import sailpoint.v3 +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 pprint import pprint +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() + new_scheduled_search.from_json(scheduled_search) + results =ScheduledSearchApi(api_client).update_scheduled_search(id, 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") + pprint(results) + 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..70dabd500 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md @@ -0,0 +1,648 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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() + new_search.from_json(search) + results =SearchApi(api_client).search_aggregate(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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search import Search +from pprint import pprint +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() + new_search.from_json(search) + SearchApi(api_client).search_count(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 +import sailpoint.v3 +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search import Search +from pprint import pprint +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() + new_search.from_json(search) + results =SearchApi(api_client).search_post(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") + pprint(results) + 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..3cc89283e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -0,0 +1,357 @@ +--- +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 and attribute promotion configuration in the Link ObjectConfig. + +[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 +import sailpoint.v3 +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 pprint import pprint +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() + new_search_attribute_config.from_json(search_attribute_config) + results =SearchAttributeConfigurationApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 associates currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config) + +### Parameters +This endpoint does not need any parameter. + +### 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + 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() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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) + # 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") + pprint(results) + 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 +import sailpoint.v3 +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 pprint import pprint +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. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, 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") + pprint(results) + 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..afe1d6250 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md @@ -0,0 +1,374 @@ +--- +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 +import sailpoint.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from pprint import pprint +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() + new_segment.from_json(segment) + results =SegmentsApi(api_client).create_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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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 +import sailpoint.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from pprint import pprint +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") + pprint(results) + 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 +import sailpoint.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from pprint import pprint +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 + 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() + new_request_body.from_json(request_body) + results =SegmentsApi(api_client).patch_segment(id, 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") + pprint(results) + 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..29c5c9b22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -0,0 +1,730 @@ +--- +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 +import sailpoint.v3 +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 pprint import pprint +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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto() + new_service_desk_integration_dto.from_json(service_desk_integration_dto) + results =ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of Service Desk integration to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | Service Desk integration with the given ID successfully deleted | | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + + try: + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to get + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto with the given ID | 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + + try: + # Get a Service Desk integration + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | script_name | **str** | True | The scriptName value of the Service Desk integration template to get + +### Return type +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + + try: + # Service Desk integration template by scriptName + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-types) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[ServiceDeskIntegrationTemplateType]**](../models/service-desk-integration-template-type) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with an array of the currently supported Service Desk integration types. | List[ServiceDeskIntegrationTemplateType] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # List Service Desk integration types + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-service-desk-integrations +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integrations) + +### 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 | 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + 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[ServiceDeskIntegrationDto]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of ServiceDeskIntegrationDto | 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 +import sailpoint.v3 +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 pprint import pprint +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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + + try: + # List existing Service Desk integrations + + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integrations() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-check-details) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + + try: + # Get the time check configuration + + results =ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to update + Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | 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. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto as updated | 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 +import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v3.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + + try: + # Patch a Service Desk Integration + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest() + new_patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + results =ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Service Desk integration to update + Body | service_desk_integration_dto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | ServiceDeskIntegrationDto as updated | 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 +import sailpoint.v3 +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 pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto() + new_service_desk_integration_dto.from_json(service_desk_integration_dto) + results =ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-status-check-details) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | queued_check_config_details | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails() + new_queued_check_config_details.from_json(queued_check_config_details) + results =ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md new file mode 100644 index 000000000..42d24417b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md @@ -0,0 +1,152 @@ +--- +id: source-usages +title: Source_Usages +pagination_label: Source_Usages +sidebar_label: Source_Usages +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source_Usages', 'Source_Usages'] +slug: /tools/sdk/python/v3/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'Source_Usages', 'Source_Usages'] +--- + +# sailpoint.v3.SourceUsagesApi + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-by-source-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of IDN source + +### Return type +[**SourceUsageStatus**](../models/source-usage-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.source_usages_api import SourceUsagesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source_usage_status import SourceUsageStatus +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-source-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | ID of IDN source + 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 | 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: **date** + +### Return type +[**List[SourceUsage]**](../models/source-usage) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Summary of source usage insights for past 12 months. | List[SourceUsage] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.source_usages_api import SourceUsagesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source_usage import SourceUsage +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md new file mode 100644 index 000000000..467d7d396 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md @@ -0,0 +1,2117 @@ +--- +id: sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Sources', 'Sources'] +slug: /tools/sdk/python/v3/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'Sources'] +--- + +# sailpoint.v3.SourcesApi + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. +[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID +[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-accounts-schema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**get-entitlements-schema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID +[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**get-source-health**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id +[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts-schema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**import-connector-file**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-entitlements-schema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) +[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) +[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + Body | provisioning_policy_dto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +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() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).create_provisioning_policy(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | source | [**Source**](../models/source) | True | + Query | provision_as_csv | **bool** | (optional) | 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. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | 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. | Source | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source import Source +from pprint import pprint +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() + new_source.from_json(source) + results =SourcesApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Body | model_schema | [**ModelSchema**](../models/model-schema) | True | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The schema was successfully created on the specified source. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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.v3.ModelSchema() # ModelSchema | + + try: + # Create Schema on Source + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).create_source_schema(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.usage_type import UsageType +from pprint import pprint +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.v3.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, 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) +``` + + + +[[Back to top]](#) + +## delete-source +Delete Source by ID +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}` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**DeleteSource202Response**](../models/delete-source202-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | DeleteSource202Response | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.delete_source202_response import DeleteSource202Response +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## get-accounts-schema +Downloads source accounts schema template +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-accounts-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully downloaded the file | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-entitlements-schema +Downloads source entitlements schema template +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-entitlements-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + Query | schema_name | **str** | (optional) | Name of entitlement schema + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully downloaded the file | | - | +400 | Client Error - 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/csv, application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, ) + # 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) +``` + + + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.v3.models.usage_type import UsageType +from pprint import pprint +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.v3.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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source object. | Source | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source import Source +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-connections +Get Source Connections by ID +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). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-connections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + +### Return type +[**SourceConnectionsDto**](../models/source-connections-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Source Connections object. | SourceConnectionsDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source_connections_dto import SourceConnectionsDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + + try: + # Get Source Connections by ID + + results =SourcesApi(api_client).get_source_connections(id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_connections(id) + print("The response of SourcesApi->get_source_connections:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-health +Fetches source health by id +This endpoint fetches source health by source's id + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-health) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + +### Return type +[**SourceHealthDto**](../models/source-health-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Fetched source health successfully | SourceHealthDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source_health_dto import SourceHealthDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested Schema was successfully retrieved. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schemas) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source ID. + Query | include_types | **str** | (optional) | 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. + Query | include_names | **str** | (optional) | A comma-separated list of schema names to filter result. + +### Return type +[**List[ModelSchema]**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The schemas were successfully retrieved. | List[ModelSchema] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-accounts-schema +Uploads source accounts schema template +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-accounts-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + | file | **bytearray** | (optional) | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully uploaded the file | ModelSchema | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-connector-file) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + | file | **bytearray** | (optional) | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Uploaded the file successfully and sent all post-upload events | Source | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source import Source +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-entitlements-schema +Uploads source entitlements schema template +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-entitlements-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Source id + Query | schema_name | **str** | (optional) | Name of entitlement schema + | file | **bytearray** | (optional) | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully uploaded the file | ModelSchema | - | +400 | Client Error - 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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-provisioning-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id + +### Return type +[**List[ProvisioningPolicyDto]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of ProvisioningPolicyDto objects | List[ProvisioningPolicyDto] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sources) + +### 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, 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* + 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: **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** + Query | for_subadmin | **str** | (optional) | 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. + Query | include_idn_source | **bool** | (optional) (default to False) | Include the IdentityNow source in the response. + +### Return type +[**List[Source]**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Source objects | List[Source] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source import Source +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source ID. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + Body | provisioning_policy_dto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.v3.models.usage_type import UsageType +from pprint import pprint +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.v3.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() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source +Update Source (Full) +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + Body | source | [**Source**](../models/source) | True | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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. | Source | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.source import Source +from pprint import pprint +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() + new_source.from_json(source) + results =SourcesApi(api_client).put_source(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + Body | model_schema | [**ModelSchema**](../models/model-schema) | True | + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema was successfully replaced. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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.v3.ModelSchema() # ModelSchema | + + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).put_source_schema(source_id, schema_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policies-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. + Body | provisioning_policy_dto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**List[ProvisioningPolicyDto]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of the ProvisioningPolicyDto was successfully replaced. | List[ProvisioningPolicyDto] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | usage_type | [**UsageType**](../models/usage-type) | True | 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. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto +from sailpoint.v3.models.usage_type import UsageType +from pprint import pprint +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.v3.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source +Update Source (Partial) +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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Source ID. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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). + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | 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. | Source | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.source import Source +from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() + +with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +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 +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source-schema) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | The Source id. +Path | schema_id | **str** | True | The Schema id. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ModelSchema**](../models/model-schema) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Schema was successfully updated. | ModelSchema | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.model_schema import ModelSchema +from pprint import pprint +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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schema(source_id, schema_id, 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") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md new file mode 100644 index 000000000..fe2175115 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md @@ -0,0 +1,617 @@ +--- +id: tagged-objects +title: Tagged_Objects +pagination_label: Tagged_Objects +sidebar_label: Tagged_Objects +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Tagged_Objects', 'Tagged_Objects'] +slug: /tools/sdk/python/v3/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'Tagged_Objects', 'Tagged_Objects'] +--- + +# sailpoint.v3.TaggedObjectsApi + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of object to delete tags from. +Path | id | **str** | True | The ID of the object to delete tags from. + +### 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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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, 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) +``` + + + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tags-to-many-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_remove_tagged_object | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.bulk_remove_tagged_object import BulkRemoveTaggedObject +from pprint import pprint +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() + new_bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_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) +``` + + + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to retrieve. +Path | id | **str** | True | The ID of the object reference to retrieve. + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tagged object by type and ID. | TaggedObject | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.tagged_object import TaggedObject +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects) + +### 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + +### Return type +[**List[TaggedObject]**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tagged objects. | List[TaggedObject] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.tagged_object import TaggedObject +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects-by-type) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to retrieve. + 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: **objectRef.id**: *eq* **objectRef.type**: *eq* + +### Return type +[**List[TaggedObject]**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all tagged objects for specified type. | List[TaggedObject] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.tagged_object import TaggedObject +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-tagged-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | type | **str** | True | The type of tagged object to update. +Path | id | **str** | True | The ID of the object reference to update. + Body | tagged_object | [**TaggedObject**](../models/tagged-object) | True | + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Tagged object by type and ID. | TaggedObject | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.tagged_object import TaggedObject +from pprint import pprint +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() + new_tagged_object.from_json(tagged_object) + results =TaggedObjectsApi(api_client).put_tagged_object(type, id, 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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tag-to-object) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | tagged_object | [**TaggedObject**](../models/tagged-object) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +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 | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.tagged_object import TaggedObject +from pprint import pprint +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() + new_tagged_object.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_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) +``` + + + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tags-to-many-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | bulk_add_tagged_object | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type +[**List[BulkTaggedObjectResponse]**](../models/bulk-tagged-object-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | List[BulkTaggedObjectResponse] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.bulk_add_tagged_object import BulkAddTaggedObject +from sailpoint.v3.models.bulk_tagged_object_response import BulkTaggedObjectResponse +from pprint import pprint +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() + new_bulk_add_tagged_object.from_json(bulk_add_tagged_object) + results =TaggedObjectsApi(api_client).set_tags_to_many_objects(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") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md new file mode 100644 index 000000000..4f99bf481 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md @@ -0,0 +1,350 @@ +--- +id: transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Transforms', 'Transforms'] +slug: /tools/sdk/python/v3/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'Transforms'] +--- + +# sailpoint.v3.TransformsApi + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track +of which users have made changes to the Transforms. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **POST** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **GET** `/transforms` | List transforms +[**update-transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | transform | [**Transform**](../models/transform) | True | The transform to be created. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Indicates the transform was successfully created and returns its representation. | TransformRead | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.transform import Transform +from sailpoint.v3.models.transform_read import TransformRead +from pprint import pprint +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() + new_transform.from_json(transform) + results =TransformsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-transform +Delete a transform +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform 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 +import sailpoint.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform to retrieve + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Transform with the given ID | TransformRead | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.transform_read import TransformRead +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-transforms) + +### 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 | name | **str** | (optional) | Name of the transform to retrieve from the list. + 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: **internal**: *eq* **name**: *eq, sw* + +### Return type +[**List[TransformRead]**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of transforms matching the given criteria. | List[TransformRead] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.transform_read import TransformRead +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-transform +Update a transform +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-transform) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the transform to update + Body | transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.transform import Transform +from sailpoint.v3.models.transform_read import TransformRead +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md new file mode 100644 index 000000000..0d8b96533 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md @@ -0,0 +1,250 @@ +--- +id: vendor-connector-mappings +title: Vendor_Connector_Mappings +pagination_label: Vendor_Connector_Mappings +sidebar_label: Vendor_Connector_Mappings +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Vendor_Connector_Mappings', 'Vendor_Connector_Mappings'] +slug: /tools/sdk/python/v3/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'Vendor_Connector_Mappings', 'Vendor_Connector_Mappings'] +--- + +# sailpoint.v3.VendorConnectorMappingsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-vendor-connector-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | vendor_connector_mapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping | - | +400 | Client Error - 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. | GetVendorConnectorMappings405Response | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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() + new_vendor_connector_mapping.from_json(vendor_connector_mapping) + results =VendorConnectorMappingsApi(api_client).create_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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-vendor-connector-mapping) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | vendor_connector_mapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response +from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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() + new_vendor_connector_mapping.from_json(vendor_connector_mapping) + results =VendorConnectorMappingsApi(api_client).delete_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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-vendor-connector-mappings) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[VendorConnectorMapping]**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully retrieved list. | List[VendorConnectorMapping] | - | +400 | Client Error - 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. | GetVendorConnectorMappings405Response | - | +429 | Too Many Requests - Returned in response to too many 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 +import sailpoint.v3 +from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md new file mode 100644 index 000000000..383af7692 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md @@ -0,0 +1,845 @@ +--- +id: work-items +title: Work_Items +pagination_label: Work_Items +sidebar_label: Work_Items +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Work_Items', 'Work_Items'] +slug: /tools/sdk/python/v3/methods/work-items +tags: ['SDK', 'Software Development Kit', 'Work_Items', 'Work_Items'] +--- + +# sailpoint.v3.WorkItemsApi + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **GET** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**send-work-item-forward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + + +## approve-approval-item +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item +Path | approval_item_id | **str** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## approve-approval-items-in-bulk +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## complete-work-item +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A WorkItems object | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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: + # Complete a Work Item + + results =WorkItemsApi(api_client).complete_work_item(id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-completed-work-items +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + 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[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of completed work items. | List[WorkItems] | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-count-completed-work-items +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsCount | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items_count import WorkItemsCount +from pprint import pprint +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: + # Count Completed Work Items + + results =WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-count-work-items +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsCount | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items_count import WorkItemsCount +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-work-item +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the work item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The work item with the given ID. | WorkItems | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-work-items-summary +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsSummary**](../models/work-items-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | WorkItemsSummary | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items_summary import WorkItemsSummary +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-work-items +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items) + +### 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 | owner_id | **str** | (optional) | ID of the work item owner. + +### Return type +[**List[WorkItems]**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of work items | List[WorkItems] | - | +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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-approval-item +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item +Path | approval_item_id | **str** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-approval-items-in-bulk +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-work-item-forward +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Success, but no data is returned. | | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_item_forward import WorkItemForward +from pprint import pprint +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 + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward() + new_work_item_forward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +``` + + + +[[Back to top]](#) + +## submit-account-selection +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the work item + Body | request_body | **map[string]object** | True | Account Selection Data map, keyed on fieldName + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A work items details object. | WorkItems | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.work_items import WorkItems +from pprint import pprint +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() + new_request_body.from_json(request_body) + results =WorkItemsApi(api_client).submit_account_selection(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md new file mode 100644 index 000000000..e99f57a3e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md @@ -0,0 +1,1185 @@ +--- +id: workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Workflows', 'Workflows'] +slug: /tools/sdk/python/v3/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'Workflows'] +--- + +# sailpoint.v3.WorkflowsApi + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-external-execute-workflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**create-workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**delete-workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **GET** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow +[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-workflow-execution) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The workflow execution ID + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## create-external-execute-workflow +Execute Workflow via External Trigger +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-external-execute-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | create_external_execute_workflow_request | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | (optional) | + +### Return type +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | CreateExternalExecuteWorkflow200Response | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response +from sailpoint.v3.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest +from pprint import pprint +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.v3.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + + try: + # Execute Workflow via External Trigger + + results =WorkflowsApi(api_client).create_external_execute_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_workflow_request | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest +from sailpoint.v3.models.workflow import Workflow +from pprint import pprint +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() + new_create_workflow_request.from_json(create_workflow_request) + results =WorkflowsApi(api_client).create_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-workflow-external-trigger +Generate External Trigger OAuth Client +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow-external-trigger) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + +### Return type +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The OAuth Client object | WorkflowOAuthClient | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + +### 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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) +``` + + + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow import Workflow +from pprint import pprint +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) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Workflow execution ID. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Workflow execution. | 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution-history) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow execution + +### Return type +[**List[WorkflowExecutionEvent]**](../models/workflow-execution-event) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow execution events for the given workflow execution | List[WorkflowExecutionEvent] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent +from pprint import pprint +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) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-executions) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Workflow ID. + 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + +### Return type +[**List[WorkflowExecution]**](../models/workflow-execution) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow executions for the specified workflow. | List[WorkflowExecution] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow_execution import WorkflowExecution +from pprint import pprint +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, ) + # 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-complete-workflow-library) + +### 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[ListCompleteWorkflowLibrary200ResponseInner]**](../models/list-complete-workflow-library200-response-inner) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow steps | List[ListCompleteWorkflowLibrary200ResponseInner] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-actions) + +### 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 | 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* + +### Return type +[**List[WorkflowLibraryAction]**](../models/workflow-library-action) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow actions | List[WorkflowLibraryAction] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-operators) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[WorkflowLibraryOperator]**](../models/workflow-library-operator) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow operators | List[WorkflowLibraryOperator] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-triggers) + +### 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 | 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* + +### Return type +[**List[WorkflowLibraryTrigger]**](../models/workflow-library-trigger) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflow triggers | List[WorkflowLibraryTrigger] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[Workflow]**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of workflows | List[Workflow] | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow import Workflow +from pprint import pprint +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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.workflow import Workflow +from pprint import pprint +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 + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =WorkflowsApi(api_client).patch_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.workflow import Workflow +from sailpoint.v3.models.workflow_body import WorkflowBody +from pprint import pprint +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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + + try: + # Update Workflow + new_workflow_body = WorkflowBody() + new_workflow_body.from_json(workflow_body) + results =WorkflowsApi(api_client).put_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +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. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-external-execute-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | test_external_execute_workflow_request | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | + +### Return type +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the test input | TestExternalExecuteWorkflow200Response | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response +from sailpoint.v3.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest +from pprint import pprint +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.v3.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + + try: + # Test Workflow via External Trigger + + results =WorkflowsApi(api_client).test_external_execute_workflow(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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +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.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the workflow + Body | test_workflow_request | [**TestWorkflowRequest**](../models/test-workflow-request) | True | + +### Return type +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | TestWorkflow200Response | - | +400 | Client Error - 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 +import sailpoint.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response +from sailpoint.v3.models.test_workflow_request import TestWorkflowRequest +from pprint import pprint +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() + new_test_workflow_request.from_json(test_workflow_request) + results =WorkflowsApi(api_client).test_workflow(id, 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") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Access.md b/docs/tools/sdk/python/Reference/V3/Models/Access.md new file mode 100644 index 000000000..feba84937 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Access.md @@ -0,0 +1,39 @@ +--- +id: access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Access', 'Access'] +slug: /tools/sdk/python/v3/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'Access'] +--- + +# Access + + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.access import Access + +access = Access( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessApps.md b/docs/tools/sdk/python/Reference/V3/Models/AccessApps.md new file mode 100644 index 000000000..3544f472a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessApps.md @@ -0,0 +1,43 @@ +--- +id: access-apps +title: AccessApps +pagination_label: AccessApps +sidebar_label: AccessApps +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessApps', 'AccessApps'] +slug: /tools/sdk/python/v3/models/access-apps +tags: ['SDK', 'Software Development Kit', 'AccessApps', 'AccessApps'] +--- + +# AccessApps + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | Name of application | [optional] +**description** | **str** | Description of application. | [optional] +**owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_apps import AccessApps + +access_apps = AccessApps( +id='2c91808568c529c60168cca6f90c1313', +name='Travel and Expense', +description='Travel and Expense Application', +owner=sailpoint.v3.models.access_apps_owner.AccessApps_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'John Doe', + email = 'john.doe@sailpoint.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessAppsOwner.md b/docs/tools/sdk/python/Reference/V3/Models/AccessAppsOwner.md new file mode 100644 index 000000000..99221b1a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessAppsOwner.md @@ -0,0 +1,40 @@ +--- +id: access-apps-owner +title: AccessAppsOwner +pagination_label: AccessAppsOwner +sidebar_label: AccessAppsOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessAppsOwner', 'AccessAppsOwner'] +slug: /tools/sdk/python/v3/models/access-apps-owner +tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'AccessAppsOwner'] +--- + +# AccessAppsOwner + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's display name. | [optional] +**email** | **str** | Owner's email. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_apps_owner import AccessAppsOwner + +access_apps_owner = AccessAppsOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='John Doe', +email='john.doe@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessConstraint.md b/docs/tools/sdk/python/Reference/V3/Models/AccessConstraint.md new file mode 100644 index 000000000..353000b6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessConstraint.md @@ -0,0 +1,37 @@ +--- +id: access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessConstraint', 'AccessConstraint'] +slug: /tools/sdk/python/v3/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint'] +--- + +# AccessConstraint + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Type of Access | [required] +**ids** | **[]str** | Must be set only if operator is SELECTED. | [optional] +**operator** | **Enum** [ 'ALL', 'SELECTED' ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required] +} + +## Example + +```python +from sailpoint.v3.models.access_constraint import AccessConstraint + +access_constraint = AccessConstraint( +type='ENTITLEMENT', +ids=[2c90ad2a70ace7d50170acf22ca90010], +operator='SELECTED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteria.md new file mode 100644 index 000000000..1d86d34d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteria.md @@ -0,0 +1,35 @@ +--- +id: access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteria', 'AccessCriteria'] +slug: /tools/sdk/python/v3/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'AccessCriteria'] +--- + +# AccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Business name for the access construct list | [optional] +**criteria_list** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_criteria import AccessCriteria + +access_criteria = AccessCriteria( +name='money-in', +criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..2598d28b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,37 @@ +--- +id: access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/python/v3/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Type of the propery to which this reference applies to | [optional] +**id** | **str** | ID of the object to which this reference applies to | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_criteria_criteria_list_inner import AccessCriteriaCriteriaListInner + +access_criteria_criteria_list_inner = AccessCriteriaCriteriaListInner( +type='ENTITLEMENT', +id='2c91808568c529c60168cca6f90c1313', +name='Administrator' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessItemRequestedFor.md b/docs/tools/sdk/python/Reference/V3/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..f40cd23ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessItemRequestedFor.md @@ -0,0 +1,38 @@ +--- +id: access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedFor', 'AccessItemRequestedFor'] +slug: /tools/sdk/python/v3/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemRequestedFor'] +--- + +# AccessItemRequestedFor + +Identity the access item is requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity the access item is requested for. | [optional] +**id** | **str** | ID of identity the access item is requested for. | [optional] +**name** | **str** | Human-readable display name of identity the access item is requested for. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_item_requested_for import AccessItemRequestedFor + +access_item_requested_for = AccessItemRequestedFor( +type='IDENTITY', +id='2c4180a46faadee4016fb4e018c20626', +name='Robert Robinson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessItemRequester.md b/docs/tools/sdk/python/Reference/V3/Models/AccessItemRequester.md new file mode 100644 index 000000000..9effff074 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessItemRequester.md @@ -0,0 +1,38 @@ +--- +id: access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemRequester', 'AccessItemRequester'] +slug: /tools/sdk/python/v3/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'AccessItemRequester'] +--- + +# AccessItemRequester + +Access item requester's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional] +**id** | **str** | Access item requester's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_item_requester import AccessItemRequester + +access_item_requester = AccessItemRequester( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20648', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessItemReviewedBy.md b/docs/tools/sdk/python/Reference/V3/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..4067fcdb5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessItemReviewedBy.md @@ -0,0 +1,38 @@ +--- +id: access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessItemReviewedBy', 'AccessItemReviewedBy'] +slug: /tools/sdk/python/v3/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'AccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +Identity who reviewed the access item request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_item_reviewed_by import AccessItemReviewedBy + +access_item_reviewed_by = AccessItemReviewedBy( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadata.md b/docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadata.md new file mode 100644 index 000000000..7f7f5a29c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadata.md @@ -0,0 +1,55 @@ +--- +id: access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessModelMetadata', 'AccessModelMetadata'] +slug: /tools/sdk/python/v3/models/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'AccessModelMetadata'] +--- + +# AccessModelMetadata + +Metadata that describes an access item + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Unique identifier for the metadata type | [optional] +**name** | **str** | Human readable name of the metadata type | [optional] +**multiselect** | **bool** | Allows selecting multiple values | [optional] [default to False] +**status** | **str** | The state of the metadata item | [optional] +**type** | **str** | The type of the metadata item | [optional] +**object_types** | **[]str** | The types of objects | [optional] +**description** | **str** | Describes the metadata item | [optional] +**values** | [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_model_metadata import AccessModelMetadata + +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/AccessModelMetadataValuesInner.md b/docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadataValuesInner.md new file mode 100644 index 000000000..bc84e0c31 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadataValuesInner.md @@ -0,0 +1,38 @@ +--- +id: access-model-metadata-values-inner +title: AccessModelMetadataValuesInner +pagination_label: AccessModelMetadataValuesInner +sidebar_label: AccessModelMetadataValuesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner'] +slug: /tools/sdk/python/v3/models/access-model-metadata-values-inner +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner'] +--- + +# AccessModelMetadataValuesInner + +An individual value to assign to the metadata item + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The value to assign to the metdata item | [optional] +**name** | **str** | Display name of the value | [optional] +**status** | **str** | The status of the individual value | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_model_metadata_values_inner import AccessModelMetadataValuesInner + +access_model_metadata_values_inner = AccessModelMetadataValuesInner( +value='development', +name='Development', +status='active' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md new file mode 100644 index 000000000..02caf1e7d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md @@ -0,0 +1,91 @@ +--- +id: access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfile', 'AccessProfile'] +slug: /tools/sdk/python/v3/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] +--- + +# AccessProfile + +Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Access Profile | [optional] [readonly] +**name** | **str** | Name of the Access Profile | [required] +**description** | **str** | Information about the Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] +**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**access_request_config** | [**Requestability**](requestability) | | [optional] +**revocation_request_config** | [**Revocability**](revocability) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile import AccessProfile + +access_profile = AccessProfile( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +created='2021-03-01T22:32:58.104Z', +modified='2021-03-02T20:22:28.104Z', +enabled=True, +owner=sailpoint.v3.models.owner_reference.OwnerReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +source=sailpoint.v3.models.access_profile_source_ref.AccessProfileSourceRef( + id = '2c91809773dee3610173fdb0b6061ef4', + type = 'SOURCE', + name = 'ODS-AD-SOURCE', ), +entitlements=[ + sailpoint.v3.models.entitlement_ref.EntitlementRef( + type = 'ENTITLEMENT', + id = '2c91809773dee32014e13e122092014e', + name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', ) + ], +requestable=True, +access_request_config=sailpoint.v3.models.requestability.Requestability( + comments_required = True, + denial_comments_required = True, + approval_schemes = [ + sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +revocation_request_config=sailpoint.v3.models.revocability.Revocability( + approval_schemes = [ + sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +provisioning_criteria=sailpoint.v3.models.provisioning_criteria_level1.ProvisioningCriteriaLevel1( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v3.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2( + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..3fc05a28b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,35 @@ +--- +id: access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme'] +slug: /tools/sdk/python/v3/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **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.v3.models.access_profile_approval_scheme import AccessProfileApprovalScheme + +access_profile_approval_scheme = AccessProfileApprovalScheme( +approver_type='GOVERNANCE_GROUP', +approver_id='46c79819-a69f-49a2-becb-12c971ae66c6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..2c955a8e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/python/v3/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_profile_ids** | **[]str** | List of IDs of Access Profiles to be deleted. | [optional] +**best_effort_only** | **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest + +access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest( +access_profile_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816], +best_effort_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..b5011d3ea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,46 @@ +--- +id: access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/python/v3/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_id** | **str** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional] +**pending** | **[]str** | List of IDs of Access Profiles which are pending deletion. | [optional] +**in_use** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse + +access_profile_bulk_delete_response = AccessProfileBulkDeleteResponse( +task_id='2c9180867817ac4d017817c491119a20', +pending=[2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816], +in_use=[ + sailpoint.v3.models.access_profile_usage.AccessProfileUsage( + access_profile_id = '2c91808876438bbb017668c21919ecca', + used_by = [ + sailpoint.v3.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner( + type = 'ROLE', + id = '2c8180857a9b3da0017aa03418480f9d', + name = 'Manager Role', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocument.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocument.md new file mode 100644 index 000000000..ca1930ba9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocument.md @@ -0,0 +1,96 @@ +--- +id: access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDocument', 'AccessProfileDocument'] +slug: /tools/sdk/python/v3/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfileDocument'] +--- + +# AccessProfileDocument + +More complete representation of an access profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Access item's description. | [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] +**synced** | **datetime** | 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] +**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False] +**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True] +**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False] +**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional] +**id** | **str** | Access profile's ID. | [required] +**name** | **str** | Access profile's name. | [required] +**source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional] +**entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional] +**entitlement_count** | **int** | Number of entitlements. | [optional] +**segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional] +**segment_count** | **int** | Number of segments with the access profile. | [optional] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_document import AccessProfileDocument + +access_profile_document = AccessProfileDocument( +description='Admin access', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:33.104Z', +enabled=True, +requestable=True, +request_comments_required=False, +owner=sailpoint.v3.models.base_access_owner.BaseAccess_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', + email = 'cloud-support@sailpoint.com', ), +id='2c9180825a6c1adc015a71c9023f0818', +name='Cloud Eng', +source=sailpoint.v3.models.access_profile_document_all_of_source.AccessProfileDocument_allOf_source( + id = 'ff8081815757d4fb0157588f3d9d008f', + name = 'Employees', ), +entitlements=[ + sailpoint.v3.models.base_entitlement.BaseEntitlement( + has_permissions = False, + description = 'Cloud engineering', + attribute = 'memberOf', + value = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', + schema = 'group', + privileged = False, + id = '2c918084575812550157589064f33b89', + name = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', ) + ], +entitlement_count=5, +segments=[ + sailpoint.v3.models.base_segment.BaseSegment( + id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', + name = 'Test Segment', ) + ], +segment_count=1, +tags=[TAG_1, TAG_2], +apps=[ + sailpoint.v3.models.access_apps.AccessApps( + id = '2c91808568c529c60168cca6f90c1313', + name = 'Travel and Expense', + description = 'Travel and Expense Application', + owner = sailpoint.v3.models.access_apps_owner.AccessApps_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'John Doe', + email = 'john.doe@sailpoint.com', ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..689231c27 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,36 @@ +--- +id: access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/python/v3/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource'] +--- + +# AccessProfileDocumentAllOfSource + +Access profile's source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Source's ID. | [optional] +**name** | **str** | Source's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_document_all_of_source import AccessProfileDocumentAllOfSource + +access_profile_document_all_of_source = AccessProfileDocumentAllOfSource( +id='ff8081815757d4fb0157588f3d9d008f', +name='Employees' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileEntitlement.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..9cd670edd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileEntitlement.md @@ -0,0 +1,54 @@ +--- +id: access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileEntitlement', 'AccessProfileEntitlement'] +slug: /tools/sdk/python/v3/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessProfileEntitlement'] +--- + +# AccessProfileEntitlement + +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.access_profile_entitlement import AccessProfileEntitlement + +access_profile_entitlement = AccessProfileEntitlement( +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/AccessProfileRef.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileRef.md new file mode 100644 index 000000000..05f48d057 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileRef.md @@ -0,0 +1,37 @@ +--- +id: access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileRef', 'AccessProfileRef'] +slug: /tools/sdk/python/v3/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef'] +--- + +# AccessProfileRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the Access Profile | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE' ] | 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. | [optional] +**name** | **str** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_ref import AccessProfileRef + +access_profile_ref = AccessProfileRef( +id='ff808081751e6e129f1518161919ecca', +type='ACCESS_PROFILE', +name='Access Profile 2567' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileRole.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileRole.md new file mode 100644 index 000000000..a63b544de --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileRole.md @@ -0,0 +1,48 @@ +--- +id: access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileRole', 'AccessProfileRole'] +slug: /tools/sdk/python/v3/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRole'] +--- + +# AccessProfileRole + +Role + +## 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] +**owner** | [**DisplayReference**](display-reference) | | [optional] +**disabled** | **bool** | | [optional] +**revocable** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_role import AccessProfileRole + +access_profile_role = AccessProfileRole( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ROLE', +owner=, +disabled=True, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..c7295f9ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md @@ -0,0 +1,37 @@ +--- +id: access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileSourceRef', 'AccessProfileSourceRef'] +slug: /tools/sdk/python/v3/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] +**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] +**name** | **str** | The display name of the associated Source | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_source_ref import AccessProfileSourceRef + +access_profile_source_ref = AccessProfileSourceRef( +id='2c91809773dee3610173fdb0b6061ef4', +type='SOURCE', +name='ODS-AD-SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSummary.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSummary.md new file mode 100644 index 000000000..c005181cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSummary.md @@ -0,0 +1,50 @@ +--- +id: access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileSummary', 'AccessProfileSummary'] +slug: /tools/sdk/python/v3/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfileSummary'] +--- + +# AccessProfileSummary + +This is a summary representation of an access profile. + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_summary import AccessProfileSummary + +access_profile_summary = AccessProfileSummary( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ACCESS_PROFILE', +source=sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +owner=, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileUsage.md new file mode 100644 index 000000000..927566380 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileUsage.md @@ -0,0 +1,40 @@ +--- +id: access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUsage', 'AccessProfileUsage'] +slug: /tools/sdk/python/v3/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUsage'] +--- + +# AccessProfileUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_profile_id** | **str** | ID of the Access Profile that is in use | [optional] +**used_by** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_usage import AccessProfileUsage + +access_profile_usage = AccessProfileUsage( +access_profile_id='2c91808876438bbb017668c21919ecca', +used_by=[ + sailpoint.v3.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner( + type = 'ROLE', + id = '2c8180857a9b3da0017aa03418480f9d', + name = 'Manager Role', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..cdda8bf36 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,38 @@ +--- +id: access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner'] +slug: /tools/sdk/python/v3/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +Role using the access profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ROLE' ] | DTO type of role using the access profile. | [optional] +**id** | **str** | ID of role using the access profile. | [optional] +**name** | **str** | Display name of role using the access profile. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_profile_usage_used_by_inner import AccessProfileUsageUsedByInner + +access_profile_usage_used_by_inner = AccessProfileUsageUsedByInner( +type='ROLE', +id='2c8180857a9b3da0017aa03418480f9d', +name='Manager Role' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md new file mode 100644 index 000000000..af8e51fd0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md @@ -0,0 +1,48 @@ +--- +id: access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequest', 'AccessRequest'] +slug: /tools/sdk/python/v3/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest'] +--- + +# AccessRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_request import AccessRequest + +access_request = AccessRequest( +requested_for=[ + '2c918084660f45d6016617daa9210584' + ], +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.v3.models.access_request_item.AccessRequestItem( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestConfig.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestConfig.md new file mode 100644 index 000000000..77e3bc1cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestConfig.md @@ -0,0 +1,57 @@ +--- +id: access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestConfig', 'AccessRequestConfig'] +slug: /tools/sdk/python/v3/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'AccessRequestConfig'] +--- + +# AccessRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvals_must_be_external** | **bool** | 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. | [optional] [default to False] +**auto_approval_enabled** | **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to False] +**reauthorization_enabled** | **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to False] +**request_on_behalf_of_config** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**approval_reminder_and_escalation_config** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**entitlement_request_config** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_request_config import AccessRequestConfig + +access_request_config = AccessRequestConfig( +approvals_must_be_external=True, +auto_approval_enabled=True, +reauthorization_enabled=True, +request_on_behalf_of_config=sailpoint.v3.models.request_on_behalf_of_config.RequestOnBehalfOfConfig( + allow_request_on_behalf_of_anyone_by_anyone = True, + allow_request_on_behalf_of_employee_by_manager = True, ), +approval_reminder_and_escalation_config=sailpoint.v3.models.approval_reminder_and_escalation_config.ApprovalReminderAndEscalationConfig( + days_until_escalation = 0, + days_between_reminders = 0, + max_reminders = 1, + fallback_approver_ref = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), ), +entitlement_request_config=sailpoint.v3.models.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/AccessRequestItem.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md new file mode 100644 index 000000000..715a5bfbf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md @@ -0,0 +1,41 @@ +--- +id: access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItem', 'AccessRequestItem'] +slug: /tools/sdk/python/v3/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestItem'] +--- + +# AccessRequestItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | 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. | [optional] +**remove_date** | **datetime** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_request_item import AccessRequestItem + +access_request_item = AccessRequestItem( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestPhases.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestPhases.md new file mode 100644 index 000000000..402de874a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestPhases.md @@ -0,0 +1,44 @@ +--- +id: access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestPhases', 'AccessRequestPhases'] +slug: /tools/sdk/python/v3/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestPhases'] +--- + +# AccessRequestPhases + +Provides additional details about this access request phase. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**started** | **datetime** | The time that this phase started. | [optional] +**finished** | **datetime** | The time that this phase finished. | [optional] +**name** | **str** | The name of this phase. | [optional] +**state** | **Enum** [ 'PENDING', 'EXECUTING', 'COMPLETED', 'CANCELLED', 'NOT_EXECUTED' ] | The state of this phase. | [optional] +**result** | **Enum** [ 'SUCCESSFUL', 'FAILED' ] | The state of this phase. | [optional] +**phase_reference** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_request_phases import AccessRequestPhases + +access_request_phases = AccessRequestPhases( +started='2020-07-11T00:00Z', +finished='2020-07-12T00:00Z', +name='APPROVAL_PHASE', +state='COMPLETED', +result='SUCCESSFUL', +phase_reference='approvalDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestResponse.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestResponse.md new file mode 100644 index 000000000..b4e82a004 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestResponse.md @@ -0,0 +1,35 @@ +--- +id: access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse', 'AccessRequestResponse'] +slug: /tools/sdk/python/v3/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessRequestResponse'] +--- + +# AccessRequestResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**existing_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_request_response import AccessRequestResponse + +access_request_response = AccessRequestResponse( +new_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}], +existing_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestTracking.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestTracking.md new file mode 100644 index 000000000..4367b6641 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestTracking.md @@ -0,0 +1,42 @@ +--- +id: access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestTracking', 'AccessRequestTracking'] +slug: /tools/sdk/python/v3/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessRequestTracking'] +--- + +# AccessRequestTracking + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **str** | The identity id in which the access request is for. | [optional] +**requested_items_details** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**attributes_hash** | **str** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**access_request_ids** | **[]str** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_request_tracking import AccessRequestTracking + +access_request_tracking = AccessRequestTracking( +requested_for='2c918084660f45d6016617daa9210584', +requested_items_details={ +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" + }, +attributes_hash='-1928438224', +access_request_ids=[5d3118c518a44ec7805450d53479ccdb] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestType.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestType.md new file mode 100644 index 000000000..5020fd4eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestType.md @@ -0,0 +1,23 @@ +--- +id: access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestType', 'AccessRequestType'] +slug: /tools/sdk/python/v3/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'AccessRequestType'] +--- + +# AccessRequestType + +Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. + +## Enum + +* `GRANT_ACCESS` (value: `'GRANT_ACCESS'`) + +* `REVOKE_ACCESS` (value: `'REVOKE_ACCESS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessReviewItem.md b/docs/tools/sdk/python/Reference/V3/Models/AccessReviewItem.md new file mode 100644 index 000000000..acc2c77b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessReviewItem.md @@ -0,0 +1,144 @@ +--- +id: access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessReviewItem', 'AccessReviewItem'] +slug: /tools/sdk/python/v3/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem'] +--- + +# AccessReviewItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_summary** | [**AccessSummary**](access-summary) | | [optional] +**identity_summary** | [**CertificationIdentitySummary**](certification-identity-summary) | | [optional] +**id** | **str** | The review item's id | [optional] +**completed** | **bool** | Whether the review item is complete | [optional] +**new_access** | **bool** | Indicates whether the review item is for new access to a source | [optional] +**decision** | [**CertificationDecision**](certification-decision) | | [optional] +**comments** | **str** | Comments for this review item | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_review_item import AccessReviewItem + +access_review_item = AccessReviewItem( +access_summary=sailpoint.v3.models.access_summary.AccessSummary( + access = sailpoint.v3.models.access_summary_access.AccessSummary_access( + type = 'IDENTITY', + id = '2c9180867160846801719932c5153fb7', + name = 'Entitlement for Company Database', ), + entitlement = sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ), + access_profile = sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + entitlements = [ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ), + role = sailpoint.v3.models.reviewable_role.ReviewableRole( + id = '2c91808a7190d06e0171993907fd0794', + name = 'Accounting-Employees', + description = 'Role for members of the accounting department with the necessary Access Profiles', + privileged = False, + revocable = False, + end_date = '2021-12-25T00:00Z', + access_profiles = [ + sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ) + ], ), ), +identity_summary=sailpoint.v3.models.certification_identity_summary.CertificationIdentitySummary( + id = '2c91808772a504f50172a9540e501ba7', + name = 'Alison Ferguso', + identity_id = '2c9180857182306001719937377a33de', + completed = True, ), +id='ef38f94347e94562b5bb8424a56397d8', +completed=False, +new_access=False, +decision='APPROVE', +comments='This user still needs access to this source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessReviewReassignment.md b/docs/tools/sdk/python/Reference/V3/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..1ceb0cfba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessReviewReassignment.md @@ -0,0 +1,41 @@ +--- +id: access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessReviewReassignment', 'AccessReviewReassignment'] +slug: /tools/sdk/python/v3/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessReviewReassignment'] +--- + +# AccessReviewReassignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign** | [**[]ReassignReference**](reassign-reference) | | [required] +**reassign_to** | **str** | The ID of the identity to which the certification is reassigned | [required] +**reason** | **str** | The reason comment for why the reassign was made | [required] +} + +## Example + +```python +from sailpoint.v3.models.access_review_reassignment import AccessReviewReassignment + +access_review_reassignment = AccessReviewReassignment( +reassign=[ + sailpoint.v3.models.reassign_reference.ReassignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'ITEM', ) + ], +reassign_to='ef38f94347e94562b5bb8424a56397d8', +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessSummary.md b/docs/tools/sdk/python/Reference/V3/Models/AccessSummary.md new file mode 100644 index 000000000..ccf87f0c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessSummary.md @@ -0,0 +1,233 @@ +--- +id: access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessSummary', 'AccessSummary'] +slug: /tools/sdk/python/v3/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary'] +--- + +# AccessSummary + +An object holding the access that is being reviewed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | [**AccessSummaryAccess**](access-summary-access) | | [optional] +**entitlement** | [**ReviewableEntitlement**](reviewable-entitlement) | | [optional] +**access_profile** | [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional] +**role** | [**ReviewableRole**](reviewable-role) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_summary import AccessSummary + +access_summary = AccessSummary( +access=sailpoint.v3.models.access_summary_access.AccessSummary_access( + type = 'IDENTITY', + id = '2c9180867160846801719932c5153fb7', + name = 'Entitlement for Company Database', ), +entitlement=sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ), +access_profile=sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + entitlements = [ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ), +role=sailpoint.v3.models.reviewable_role.ReviewableRole( + id = '2c91808a7190d06e0171993907fd0794', + name = 'Accounting-Employees', + description = 'Role for members of the accounting department with the necessary Access Profiles', + privileged = False, + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + revocable = False, + end_date = '2021-12-25T00:00Z', + access_profiles = [ + sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + entitlements = [ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ) + ], + entitlements = [ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessSummaryAccess.md b/docs/tools/sdk/python/Reference/V3/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..80beee4f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessSummaryAccess.md @@ -0,0 +1,37 @@ +--- +id: access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessSummaryAccess', 'AccessSummaryAccess'] +slug: /tools/sdk/python/v3/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryAccess'] +--- + +# AccessSummaryAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The ID of the item being certified | [optional] +**name** | **str** | The name of the item being certified | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_summary_access import AccessSummaryAccess + +access_summary_access = AccessSummaryAccess( +type='IDENTITY', +id='2c9180867160846801719932c5153fb7', +name='Entitlement for Company Database' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessType.md b/docs/tools/sdk/python/Reference/V3/Models/AccessType.md new file mode 100644 index 000000000..92fa05b8c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessType.md @@ -0,0 +1,23 @@ +--- +id: access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessType', 'AccessType'] +slug: /tools/sdk/python/v3/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'AccessType'] +--- + +# AccessType + +Access type of API Client indicating online or offline use + +## Enum + +* `ONLINE` (value: `'ONLINE'`) + +* `OFFLINE` (value: `'OFFLINE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Account.md b/docs/tools/sdk/python/Reference/V3/Models/Account.md new file mode 100644 index 000000000..f75c924dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Account.md @@ -0,0 +1,93 @@ +--- +id: account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Account', 'Account'] +slug: /tools/sdk/python/v3/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'Account'] +--- + +# Account + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**source_id** | **str** | The unique ID of the source this account belongs to | [required] +**source_name** | **str** | The display name of the source this account belongs to | [required] +**identity_id** | **str** | The unique ID of the identity this account is correlated to | [optional] +**cloud_lifecycle_state** | **str** | The lifecycle state of the identity this account is correlated to | [optional] +**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional] +**connection_type** | **str** | The connection type of the source this account is from | [optional] +**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False] +**recommendation** | [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional] +**attributes** | **map[string]object** | The account attributes that are aggregated | [required] +**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required] +**description** | **str** | A description of the account | [optional] +**disabled** | **bool** | Indicates if the account is currently disabled | [required] +**locked** | **bool** | Indicates if the account is currently locked | [required] +**native_identity** | **str** | The unique ID of the account generated by the source system | [required] +**system_account** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required] +**uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | [required] +**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional] +**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required] +**has_entitlements** | **bool** | Indicates if the account has entitlements | [required] +**identity** | [**AccountAllOfIdentity**](account-all-of-identity) | | [optional] +**source_owner** | [**AccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional] +**features** | **str** | A string list containing the owning source's features | [optional] +**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional] +**owner_identity** | [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account import Account + +account = Account( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +source_id='2c9180835d2e5168015d32f890ca1581', +source_name='Employees', +identity_id='2c9180835d2e5168015d32f890ca1581', +cloud_lifecycle_state='active', +identity_state='ACTIVE', +connection_type='direct', +is_machine=True, +recommendation=, +attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support}, +authoritative=False, +description='', +disabled=False, +locked=False, +native_identity='552775', +system_account=False, +uncorrelated=False, +uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}', +manually_correlated=False, +has_entitlements=True, +identity=sailpoint.v3.models.account_all_of_identity.Account_allOf_identity( + id = '2c918084660f45d6016617daa9210584', + type = 'IDENTITY', + name = 'John Doe', ), +source_owner=sailpoint.v3.models.account_all_of_source_owner.Account_allOf_sourceOwner( + id = '2c918084660f45d6016617daa9210584', + type = 'IDENTITY', + name = 'Adam Kennedy', ), +features='ENABLE', +origin='AGGREGATED', +owner_identity= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAction.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAction.md new file mode 100644 index 000000000..dc1a6058f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAction.md @@ -0,0 +1,36 @@ +--- +id: account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAction', 'AccountAction'] +slug: /tools/sdk/python/v3/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'AccountAction'] +--- + +# AccountAction + +Object for specifying Actions to be performed on a specified list of sources' account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **Enum** [ 'ENABLE', 'DISABLE' ] | Describes if action will be enabled or disabled | [optional] +**source_ids** | **[]str** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_action import AccountAction + +account_action = AccountAction( +action='ENABLE', +source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountActivity.md b/docs/tools/sdk/python/Reference/V3/Models/AccountActivity.md new file mode 100644 index 000000000..b1b0d5acc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountActivity.md @@ -0,0 +1,100 @@ +--- +id: account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivity', 'AccountActivity'] +slug: /tools/sdk/python/v3/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity'] +--- + +# AccountActivity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the account activity | [optional] +**name** | **str** | The name of the activity | [optional] +**created** | **datetime** | When the activity was first created | [optional] +**modified** | **datetime** | When the activity was last modified | [optional] +**completed** | **datetime** | When the activity was completed | [optional] +**completion_status** | [**CompletionStatus**](completion-status) | | [optional] +**type** | **str** | 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). | [optional] +**requester_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**target_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**errors** | **[]str** | A list of error messages, if any, that were encountered. | [optional] +**warnings** | **[]str** | A list of warning messages, if any, that were encountered. | [optional] +**items** | [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional] +**execution_status** | [**ExecutionStatus**](execution-status) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_activity import AccountActivity + +account_activity = AccountActivity( +id='2c9180835d2e5168015d32f890ca1581', +name='2c9180835d2e5168015d32f890ca1581', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +completed='2018-10-19T13:49:37.385Z', +completion_status='SUCCESS', +type='appRequest', +requester_identity_summary=sailpoint.v3.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +target_identity_summary=sailpoint.v3.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +errors=[sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.], +warnings=[Some warning, another warning], +items=[ + sailpoint.v3.models.account_activity_item.AccountActivityItem( + id = '48c545831b264409a81befcabb0e3c5a', + name = '48c545831b264409a81befcabb0e3c5a', + requested = '2017-07-11T18:45:37.098Z', + approval_status = 'PENDING', + provisioning_status = 'PENDING', + requester_comment = sailpoint.v3.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), + reviewer_identity_summary = sailpoint.v3.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), + reviewer_comment = sailpoint.v3.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), + operation = 'ADD', + attribute = 'detectedRoles', + value = 'Treasury Analyst [AccessProfile-1529010191212]', + native_identity = 'Sandie.Camero', + source_id = '2c91808363ef85290164000587130c0c', + account_request_info = sailpoint.v3.models.account_request_info.AccountRequestInfo( + requested_object_id = '2c91808563ef85690164001c31140c0c', + requested_object_name = 'Treasury Analyst', + requested_object_type = 'ACCESS_PROFILE', ), + client_metadata = {customKey1=custom value 1, customKey2=custom value 2}, + remove_date = '2020-07-11T00:00Z', ) + ], +execution_status='COMPLETED', +client_metadata={customKey1=custom value 1, customKey2=custom value 2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..413182f10 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,31 @@ +--- +id: account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus'] +slug: /tools/sdk/python/v3/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +The state of an approval status + +## Enum + +* `FINISHED` (value: `'FINISHED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `RETURNED` (value: `'RETURNED'`) + +* `EXPIRED` (value: `'EXPIRED'`) + +* `PENDING` (value: `'PENDING'`) + +* `CANCELED` (value: `'CANCELED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountActivityDocument.md b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityDocument.md new file mode 100644 index 000000000..f9c1e1ab9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityDocument.md @@ -0,0 +1,138 @@ +--- +id: account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityDocument', 'AccountActivityDocument'] +slug: /tools/sdk/python/v3/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountActivityDocument'] +--- + +# AccountActivityDocument + +AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of account activity. | [optional] +**action** | **str** | Type of action performed in the activity. | [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] +**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] +**stage** | **str** | Activity's current stage. | [optional] +**status** | **str** | Activity's current status. | [optional] +**requester** | [**ActivityIdentity**](activity-identity) | | [optional] +**recipient** | [**ActivityIdentity**](activity-identity) | | [optional] +**tracking_number** | **str** | Account activity's tracking number. | [optional] +**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional] +**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional] +**approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional] +**original_requests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**expansion_items** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**account_requests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**sources** | **str** | Sources involved in the account activity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_activity_document import AccountActivityDocument + +account_activity_document = AccountActivityDocument( +id='2c91808375d8e80a0175e1f88a575222', +action='Identity Refresh.', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +stage='Completed', +status='Complete', +requester=, +recipient=, +tracking_number='61aad0c9e8134eca89e76a35e0cabe3f', +errors=[ + '' + ], +warnings=[ + '' + ], +approvals=[ + sailpoint.v3.models.approval.Approval( + comments = [ + sailpoint.v3.models.approval_comment.ApprovalComment( + comment = 'This request was autoapproved by our automated ETS subscriber.', + commenter = 'Automated AR Approval', + date = '2018-06-25T20:22:28.104Z', ) + ], + modified = '2018-06-25T20:22:28.104Z', + owner = null, + result = 'Finished', + attribute_request = sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), + source = null, ) + ], +original_requests=[ + sailpoint.v3.models.original_request.OriginalRequest( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + result = sailpoint.v3.models.result.Result( + status = 'Manual Task Created', ), + attribute_requests = [ + sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'add', + source = null, ) + ], +expansion_items=[ + sailpoint.v3.models.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 = null, + id = 'ac2887ffe0e7435a8c18c73f7ae94c7b', + state = 'EXECUTING', ) + ], +account_requests=[ + sailpoint.v3.models.account_request.AccountRequest( + account_id = 'John.Doe', + attribute_requests = [ + sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'Modify', + provisioning_target = null, + result = sailpoint.v3.models.account_request_result.AccountRequest_result( + errors = [ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], + status = 'failed', + ticket_id = '', ), + source = null, ) + ], +sources='smartsheet-test, airtable-v4, IdentityNow' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountActivityItem.md b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityItem.md new file mode 100644 index 000000000..fe91991f6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityItem.md @@ -0,0 +1,78 @@ +--- +id: account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityItem', 'AccountActivityItem'] +slug: /tools/sdk/python/v3/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivityItem'] +--- + +# AccountActivityItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Item id | [optional] +**name** | **str** | Human-readable display name of item | [optional] +**requested** | **datetime** | Date and time item was requested | [optional] +**approval_status** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**provisioning_status** | [**ProvisioningState**](provisioning-state) | | [optional] +**requester_comment** | [**Comment**](comment) | | [optional] +**reviewer_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional] +**reviewer_comment** | [**Comment**](comment) | | [optional] +**operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**attribute** | **str** | Attribute to which account activity applies | [optional] +**value** | **str** | Value of attribute | [optional] +**native_identity** | **str** | Native identity in the target system to which the account activity applies | [optional] +**source_id** | **str** | Id of Source to which account activity applies | [optional] +**account_request_info** | [**AccountRequestInfo**](account-request-info) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_activity_item import AccountActivityItem + +account_activity_item = AccountActivityItem( +id='48c545831b264409a81befcabb0e3c5a', +name='48c545831b264409a81befcabb0e3c5a', +requested='2017-07-11T18:45:37.098Z', +approval_status='PENDING', +provisioning_status='PENDING', +requester_comment=sailpoint.v3.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), +reviewer_identity_summary=sailpoint.v3.models.identity_summary.IdentitySummary( + id = 'ff80818155fe8c080155fe8d925b0316', + name = 'SailPoint Services', + identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd', + completed = True, ), +reviewer_comment=sailpoint.v3.models.comment.Comment( + commenter_id = '2c918084660f45d6016617daa9210584', + commenter_name = 'Adam Kennedy', + body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', + date = '2017-07-11T18:45:37.098Z', ), +operation='ADD', +attribute='detectedRoles', +value='Treasury Analyst [AccessProfile-1529010191212]', +native_identity='Sandie.Camero', +source_id='2c91808363ef85290164000587130c0c', +account_request_info=sailpoint.v3.models.account_request_info.AccountRequestInfo( + requested_object_id = '2c91808563ef85690164001c31140c0c', + requested_object_name = 'Treasury Analyst', + requested_object_type = 'ACCESS_PROFILE', ), +client_metadata={customKey1=custom value 1, customKey2=custom value 2}, +remove_date='2020-07-11T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountActivityItemOperation.md b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..50219ea0c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountActivityItemOperation.md @@ -0,0 +1,39 @@ +--- +id: account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivityItemOperation', 'AccountActivityItemOperation'] +slug: /tools/sdk/python/v3/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'AccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +Represents an operation in an account activity item + +## Enum + +* `ADD` (value: `'ADD'`) + +* `CREATE` (value: `'CREATE'`) + +* `MODIFY` (value: `'MODIFY'`) + +* `DELETE` (value: `'DELETE'`) + +* `DISABLE` (value: `'DISABLE'`) + +* `ENABLE` (value: `'ENABLE'`) + +* `UNLOCK` (value: `'UNLOCK'`) + +* `LOCK` (value: `'LOCK'`) + +* `REMOVE` (value: `'REMOVE'`) + +* `SET` (value: `'SET'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/python/Reference/V3/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..01a4fedaf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountActivitySearchedItem.md @@ -0,0 +1,138 @@ +--- +id: account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem'] +slug: /tools/sdk/python/v3/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem'] +--- + +# AccountActivitySearchedItem + +AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of account activity. | [optional] +**action** | **str** | Type of action performed in the activity. | [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] +**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] +**stage** | **str** | Activity's current stage. | [optional] +**status** | **str** | Activity's current status. | [optional] +**requester** | [**ActivityIdentity**](activity-identity) | | [optional] +**recipient** | [**ActivityIdentity**](activity-identity) | | [optional] +**tracking_number** | **str** | Account activity's tracking number. | [optional] +**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional] +**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional] +**approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional] +**original_requests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**expansion_items** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**account_requests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**sources** | **str** | Sources involved in the account activity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_activity_searched_item import AccountActivitySearchedItem + +account_activity_searched_item = AccountActivitySearchedItem( +id='2c91808375d8e80a0175e1f88a575222', +action='Identity Refresh.', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +stage='Completed', +status='Complete', +requester=, +recipient=, +tracking_number='61aad0c9e8134eca89e76a35e0cabe3f', +errors=[ + '' + ], +warnings=[ + '' + ], +approvals=[ + sailpoint.v3.models.approval.Approval( + comments = [ + sailpoint.v3.models.approval_comment.ApprovalComment( + comment = 'This request was autoapproved by our automated ETS subscriber.', + commenter = 'Automated AR Approval', + date = '2018-06-25T20:22:28.104Z', ) + ], + modified = '2018-06-25T20:22:28.104Z', + owner = null, + result = 'Finished', + attribute_request = sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), + source = null, ) + ], +original_requests=[ + sailpoint.v3.models.original_request.OriginalRequest( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + result = sailpoint.v3.models.result.Result( + status = 'Manual Task Created', ), + attribute_requests = [ + sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'add', + source = null, ) + ], +expansion_items=[ + sailpoint.v3.models.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 = null, + id = 'ac2887ffe0e7435a8c18c73f7ae94c7b', + state = 'EXECUTING', ) + ], +account_requests=[ + sailpoint.v3.models.account_request.AccountRequest( + account_id = 'John.Doe', + attribute_requests = [ + sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], + op = 'Modify', + provisioning_target = null, + result = sailpoint.v3.models.account_request_result.AccountRequest_result( + errors = [ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], + status = 'failed', + ticket_id = '', ), + source = null, ) + ], +sources='smartsheet-test, airtable-v4, IdentityNow' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfIdentity.md new file mode 100644 index 000000000..7e00ca34d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfIdentity.md @@ -0,0 +1,38 @@ +--- +id: account-all-of-identity +title: AccountAllOfIdentity +pagination_label: AccountAllOfIdentity +sidebar_label: AccountAllOfIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfIdentity', 'AccountAllOfIdentity'] +slug: /tools/sdk/python/v3/models/account-all-of-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'AccountAllOfIdentity'] +--- + +# AccountAllOfIdentity + +The identity this account is correlated to + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the identity | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional] +**name** | **str** | display name of identity | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_all_of_identity import AccountAllOfIdentity + +account_all_of_identity = AccountAllOfIdentity( +id='2c918084660f45d6016617daa9210584', +type='IDENTITY', +name='John Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfOwnerIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfOwnerIdentity.md new file mode 100644 index 000000000..09e2181b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfOwnerIdentity.md @@ -0,0 +1,37 @@ +--- +id: account-all-of-owner-identity +title: AccountAllOfOwnerIdentity +pagination_label: AccountAllOfOwnerIdentity +sidebar_label: AccountAllOfOwnerIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity'] +slug: /tools/sdk/python/v3/models/account-all-of-owner-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity'] +--- + +# AccountAllOfOwnerIdentity + + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.account_all_of_owner_identity import AccountAllOfOwnerIdentity + +account_all_of_owner_identity = AccountAllOfOwnerIdentity( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfRecommendation.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfRecommendation.md new file mode 100644 index 000000000..75f810d60 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfRecommendation.md @@ -0,0 +1,35 @@ +--- +id: account-all-of-recommendation +title: AccountAllOfRecommendation +pagination_label: AccountAllOfRecommendation +sidebar_label: AccountAllOfRecommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation'] +slug: /tools/sdk/python/v3/models/account-all-of-recommendation +tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation'] +--- + +# AccountAllOfRecommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required] +**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] +} + +## Example + +```python +from sailpoint.v3.models.account_all_of_recommendation import AccountAllOfRecommendation + +account_all_of_recommendation = AccountAllOfRecommendation( +type='MACHINE', +method='DISCOVERY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfSourceOwner.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfSourceOwner.md new file mode 100644 index 000000000..9555a6194 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAllOfSourceOwner.md @@ -0,0 +1,38 @@ +--- +id: account-all-of-source-owner +title: AccountAllOfSourceOwner +pagination_label: AccountAllOfSourceOwner +sidebar_label: AccountAllOfSourceOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner'] +slug: /tools/sdk/python/v3/models/account-all-of-source-owner +tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner'] +--- + +# AccountAllOfSourceOwner + +The owner of the source this account belongs to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the identity | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional] +**name** | **str** | display name of identity | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_all_of_source_owner import AccountAllOfSourceOwner + +account_all_of_source_owner = AccountAllOfSourceOwner( +id='2c918084660f45d6016617daa9210584', +type='IDENTITY', +name='Adam Kennedy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAttributes.md new file mode 100644 index 000000000..07cb1e2e0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAttributes.md @@ -0,0 +1,33 @@ +--- +id: account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributes', 'AccountAttributes'] +slug: /tools/sdk/python/v3/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'AccountAttributes'] +--- + +# AccountAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **map[string]object** | The schema attribute values for the account | [required] +} + +## Example + +```python +from sailpoint.v3.models.account_attributes import AccountAttributes + +account_attributes = AccountAttributes( +attributes={city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAttributesCreate.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..c19a843bd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAttributesCreate.md @@ -0,0 +1,33 @@ +--- +id: account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreate', 'AccountAttributesCreate'] +slug: /tools/sdk/python/v3/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'AccountAttributesCreate'] +--- + +# AccountAttributesCreate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] +} + +## Example + +```python +from sailpoint.v3.models.account_attributes_create import AccountAttributesCreate + +account_attributes_create = AccountAttributesCreate( +attributes={sourceId=34bfcbe116c9407464af37acbaf7a4dc, city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..8b80b625f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,34 @@ +--- +id: account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes'] +slug: /tools/sdk/python/v3/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +The schema attribute values for the account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | Target source to create an account | [required] +} + +## Example + +```python +from sailpoint.v3.models.account_attributes_create_attributes import AccountAttributesCreateAttributes + +account_attributes_create_attributes = AccountAttributesCreateAttributes( +source_id='34bfcbe116c9407464af37acbaf7a4dc' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccountRequest.md new file mode 100644 index 000000000..0fa31a5ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountRequest.md @@ -0,0 +1,62 @@ +--- +id: account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequest', 'AccountRequest'] +slug: /tools/sdk/python/v3/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest'] +--- + +# AccountRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Unique ID of the account | [optional] +**attribute_requests** | [**[]AttributeRequest**](attribute-request) | | [optional] +**op** | **str** | The operation that was performed | [optional] +**provisioning_target** | [**AccountSource**](account-source) | | [optional] +**result** | [**AccountRequestResult**](account-request-result) | | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_request import AccountRequest + +account_request = AccountRequest( +account_id='John.Doe', +attribute_requests=[ + sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], +op='Modify', +provisioning_target=, +result=sailpoint.v3.models.account_request_result.AccountRequest_result( + errors = [ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], + status = 'failed', + ticket_id = '', ), +source= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountRequestInfo.md b/docs/tools/sdk/python/Reference/V3/Models/AccountRequestInfo.md new file mode 100644 index 000000000..6c4a97332 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountRequestInfo.md @@ -0,0 +1,38 @@ +--- +id: account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequestInfo', 'AccountRequestInfo'] +slug: /tools/sdk/python/v3/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestInfo'] +--- + +# AccountRequestInfo + +If an account activity item is associated with an access request, captures details of that request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_object_id** | **str** | Id of requested object | [optional] +**requested_object_name** | **str** | Human-readable name of requested object | [optional] +**requested_object_type** | [**RequestableObjectType**](requestable-object-type) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_request_info import AccountRequestInfo + +account_request_info = AccountRequestInfo( +requested_object_id='2c91808563ef85690164001c31140c0c', +requested_object_name='Treasury Analyst', +requested_object_type='ACCESS_PROFILE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountRequestResult.md b/docs/tools/sdk/python/Reference/V3/Models/AccountRequestResult.md new file mode 100644 index 000000000..893c799f6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountRequestResult.md @@ -0,0 +1,48 @@ +--- +id: account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountRequestResult', 'AccountRequestResult'] +slug: /tools/sdk/python/v3/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountRequestResult'] +--- + +# AccountRequestResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | **[]str** | Error message. | [optional] +**status** | **str** | The status of the account request | [optional] +**ticket_id** | **str** | ID of associated ticket. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_request_result import AccountRequestResult + +account_request_result = AccountRequestResult( +errors=[ + '[ConnectorError] [ + { + "code": "unrecognized_keys", + "keys": [ + "groups" + ], + "path": [], + "message": "Unrecognized key(s) in object: 'groups'" + } +] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)' + ], +status='failed', +ticket_id='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountSource.md b/docs/tools/sdk/python/Reference/V3/Models/AccountSource.md new file mode 100644 index 000000000..c9fe48e66 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountSource.md @@ -0,0 +1,37 @@ +--- +id: account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountSource', 'AccountSource'] +slug: /tools/sdk/python/v3/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource'] +--- + +# AccountSource + + +## 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] +**type** | **str** | Type of source returned. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_source import AccountSource + +account_source = AccountSource( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +type='Delimited File' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountToggleRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccountToggleRequest.md new file mode 100644 index 000000000..dc566fe75 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountToggleRequest.md @@ -0,0 +1,36 @@ +--- +id: account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountToggleRequest', 'AccountToggleRequest'] +slug: /tools/sdk/python/v3/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggleRequest'] +--- + +# AccountToggleRequest + +Request used for account enable/disable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**force_provisioning** | **bool** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_toggle_request import AccountToggleRequest + +account_toggle_request = AccountToggleRequest( +external_verification_id='3f9180835d2e5168015d32f890ca1581', +force_provisioning=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUnlockRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..2d7fddc38 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUnlockRequest.md @@ -0,0 +1,38 @@ +--- +id: account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUnlockRequest', 'AccountUnlockRequest'] +slug: /tools/sdk/python/v3/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlockRequest'] +--- + +# AccountUnlockRequest + +Request used for account unlock + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**unlock_idn_account** | **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**force_provisioning** | **bool** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_unlock_request import AccountUnlockRequest + +account_unlock_request = AccountUnlockRequest( +external_verification_id='3f9180835d2e5168015d32f890ca1581', +unlock_idn_account=False, +force_provisioning=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md new file mode 100644 index 000000000..a1615a57b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md @@ -0,0 +1,35 @@ +--- +id: account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountUsage', 'AccountUsage'] +slug: /tools/sdk/python/v3/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'AccountUsage'] +--- + +# AccountUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional] +**count** | **int** | The number of days within the month that the account was active in a source. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_usage import AccountUsage + +account_usage = AccountUsage( +var_date='Thu Apr 20 20:00:00 EDT 2023', +count=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountsAsyncResult.md b/docs/tools/sdk/python/Reference/V3/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..dc0c33d12 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountsAsyncResult.md @@ -0,0 +1,34 @@ +--- +id: accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsAsyncResult', 'AccountsAsyncResult'] +slug: /tools/sdk/python/v3/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'AccountsAsyncResult'] +--- + +# AccountsAsyncResult + +Accounts async response containing details on started async process + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the task | [required] +} + +## Example + +```python +from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + +accounts_async_result = AccountsAsyncResult( +id='2c91808474683da6017468693c260195' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountsExportReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..c4a4384b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountsExportReportArguments.md @@ -0,0 +1,36 @@ +--- +id: accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsExportReportArguments', 'AccountsExportReportArguments'] +slug: /tools/sdk/python/v3/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'AccountsExportReportArguments'] +--- + +# AccountsExportReportArguments + +Arguments for Account Export report (ACCOUNTS) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | **str** | Source ID. | [required] +**source_name** | **str** | Source name. | [required] +} + +## Example + +```python +from sailpoint.v3.models.accounts_export_report_arguments import AccountsExportReportArguments + +accounts_export_report_arguments = AccountsExportReportArguments( +application='2c9180897eSourceIde781782f705b9', +source_name='Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ActivateCampaignOptions.md b/docs/tools/sdk/python/Reference/V3/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..4dabfc9ca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ActivateCampaignOptions.md @@ -0,0 +1,33 @@ +--- +id: activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivateCampaignOptions', 'ActivateCampaignOptions'] +slug: /tools/sdk/python/v3/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time_zone** | **str** | 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. | [optional] [default to 'Z'] +} + +## Example + +```python +from sailpoint.v3.models.activate_campaign_options import ActivateCampaignOptions + +activate_campaign_options = ActivateCampaignOptions( +time_zone='Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ActivityIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/ActivityIdentity.md new file mode 100644 index 000000000..1c4bf874d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ActivityIdentity.md @@ -0,0 +1,37 @@ +--- +id: activity-identity +title: ActivityIdentity +pagination_label: ActivityIdentity +sidebar_label: ActivityIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivityIdentity', 'ActivityIdentity'] +slug: /tools/sdk/python/v3/models/activity-identity +tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'ActivityIdentity'] +--- + +# ActivityIdentity + + +## 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] +**type** | **str** | Type of object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.activity_identity import ActivityIdentity + +activity_identity = ActivityIdentity( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +type='Identity' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ActivityInsights.md b/docs/tools/sdk/python/Reference/V3/Models/ActivityInsights.md new file mode 100644 index 000000000..a96827cad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ActivityInsights.md @@ -0,0 +1,38 @@ +--- +id: activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ActivityInsights', 'ActivityInsights'] +slug: /tools/sdk/python/v3/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'ActivityInsights'] +--- + +# ActivityInsights + +Insights into account activity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | UUID of the account | [optional] +**usage_days** | **int** | The number of days of activity | [optional] +**usage_days_state** | **Enum** [ 'COMPLETE', 'UNKNOWN' ] | Status indicating if the activity is complete or unknown | [optional] +} + +## Example + +```python +from sailpoint.v3.models.activity_insights import ActivityInsights + +activity_insights = ActivityInsights( +account_id='c4ddd5421d8549f0abd309162cafd3b1', +usage_days=45, +usage_days_state='COMPLETE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AdminReviewReassign.md b/docs/tools/sdk/python/Reference/V3/Models/AdminReviewReassign.md new file mode 100644 index 000000000..6330ea240 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AdminReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AdminReviewReassign', 'AdminReviewReassign'] +slug: /tools/sdk/python/v3/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'AdminReviewReassign'] +--- + +# AdminReviewReassign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification_ids** | **[]str** | List of certification IDs to reassign | [optional] +**reassign_to** | [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**reason** | **str** | Comment to explain why the certification was reassigned | [optional] +} + +## Example + +```python +from sailpoint.v3.models.admin_review_reassign import AdminReviewReassign + +admin_review_reassign = AdminReviewReassign( +certification_ids=[af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3], +reassign_to=sailpoint.v3.models.admin_review_reassign_reassign_to.AdminReviewReassign_reassignTo( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'IDENTITY', ), +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/python/Reference/V3/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..b3468e59c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,35 @@ +--- +id: admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo'] +slug: /tools/sdk/python/v3/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID to which the review is being assigned. | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the ID provided. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.admin_review_reassign_reassign_to import AdminReviewReassignReassignTo + +admin_review_reassign_reassign_to = AdminReviewReassignReassignTo( +id='ef38f94347e94562b5bb8424a56397d8', +type='IDENTITY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AggregationResult.md b/docs/tools/sdk/python/Reference/V3/Models/AggregationResult.md new file mode 100644 index 000000000..2269953fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AggregationResult.md @@ -0,0 +1,37 @@ +--- +id: aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AggregationResult', 'AggregationResult'] +slug: /tools/sdk/python/v3/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResult'] +--- + +# AggregationResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregations** | **object** | 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. | [optional] +**hits** | **[]object** | The results of the aggregation search query. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.aggregation_result import AggregationResult + +aggregation_result = AggregationResult( +aggregations={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=[ + sailpoint.v3.models.search_documents.SearchDocuments() + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AggregationType.md b/docs/tools/sdk/python/Reference/V3/Models/AggregationType.md new file mode 100644 index 000000000..925d9d6ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AggregationType.md @@ -0,0 +1,23 @@ +--- +id: aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AggregationType', 'AggregationType'] +slug: /tools/sdk/python/v3/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'AggregationType'] +--- + +# AggregationType + +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. + +## Enum + +* `DSL` (value: `'DSL'`) + +* `SAILPOINT` (value: `'SAILPOINT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Aggregations.md b/docs/tools/sdk/python/Reference/V3/Models/Aggregations.md new file mode 100644 index 000000000..f71a1fb62 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Aggregations.md @@ -0,0 +1,53 @@ +--- +id: aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Aggregations', 'Aggregations'] +slug: /tools/sdk/python/v3/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'Aggregations'] +--- + +# Aggregations + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | [**NestedAggregation**](nested-aggregation) | | [optional] +**metric** | [**MetricAggregation**](metric-aggregation) | | [optional] +**filter** | [**FilterAggregation**](filter-aggregation) | | [optional] +**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.aggregations import Aggregations + +aggregations = Aggregations( +nested=sailpoint.v3.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), +metric=sailpoint.v3.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), +filter=sailpoint.v3.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + type = 'TERM', + field = 'access.type', + value = 'ENTITLEMENT', ), +bucket=sailpoint.v3.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + type = 'TERMS', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/App.md b/docs/tools/sdk/python/Reference/V3/Models/App.md new file mode 100644 index 000000000..91605f044 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/App.md @@ -0,0 +1,43 @@ +--- +id: app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'App', 'App'] +slug: /tools/sdk/python/v3/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'App'] +--- + +# App + + +## 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] +**source** | [**Reference**](reference) | | [optional] +**account** | [**AppAllOfAccount**](app-all-of-account) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.app import App + +app = App( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +source=sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +account=sailpoint.v3.models.app_all_of_account.App_allOf_account( + id = '2c9180837dfe6949017e21f3d8cd6d49', + account_id = 'CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AppAllOfAccount.md b/docs/tools/sdk/python/Reference/V3/Models/AppAllOfAccount.md new file mode 100644 index 000000000..02ca368f3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AppAllOfAccount.md @@ -0,0 +1,35 @@ +--- +id: app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AppAllOfAccount', 'AppAllOfAccount'] +slug: /tools/sdk/python/v3/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'AppAllOfAccount'] +--- + +# AppAllOfAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The SailPoint generated unique ID | [optional] +**account_id** | **str** | The account ID generated by the source | [optional] +} + +## Example + +```python +from sailpoint.v3.models.app_all_of_account import AppAllOfAccount + +app_all_of_account = AppAllOfAccount( +id='2c9180837dfe6949017e21f3d8cd6d49', +account_id='CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Approval.md b/docs/tools/sdk/python/Reference/V3/Models/Approval.md new file mode 100644 index 000000000..b3cd3123a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Approval.md @@ -0,0 +1,51 @@ +--- +id: approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Approval', 'Approval'] +slug: /tools/sdk/python/v3/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval'] +--- + +# Approval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments** | [**[]ApprovalComment**](approval-comment) | | [optional] +**modified** | **datetime** | A date-time in ISO-8601 format | [optional] +**owner** | [**ActivityIdentity**](activity-identity) | | [optional] +**result** | **str** | The result of the approval | [optional] +**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval import Approval + +approval = Approval( +comments=[ + sailpoint.v3.models.approval_comment.ApprovalComment( + comment = 'This request was autoapproved by our automated ETS subscriber.', + commenter = 'Automated AR Approval', + date = '2018-06-25T20:22:28.104Z', ) + ], +modified='2018-06-25T20:22:28.104Z', +owner=, +result='Finished', +attribute_request=sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), +source= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalComment.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalComment.md new file mode 100644 index 000000000..0ffca5665 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalComment.md @@ -0,0 +1,37 @@ +--- +id: approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalComment', 'ApprovalComment'] +slug: /tools/sdk/python/v3/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'ApprovalComment'] +--- + +# ApprovalComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | The comment text | [optional] +**commenter** | **str** | The name of the commenter | [optional] +**var_date** | **datetime** | A date-time in ISO-8601 format | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_comment import ApprovalComment + +approval_comment = ApprovalComment( +comment='This request was autoapproved by our automated ETS subscriber.', +commenter='Automated AR Approval', +var_date='2018-06-25T20:22:28.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalForwardHistory.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..15008aa57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalForwardHistory.md @@ -0,0 +1,43 @@ +--- +id: approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalForwardHistory', 'ApprovalForwardHistory'] +slug: /tools/sdk/python/v3/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'ApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**old_approver_name** | **str** | Display name of approver from whom the approval was forwarded. | [optional] +**new_approver_name** | **str** | Display name of approver to whom the approval was forwarded. | [optional] +**comment** | **str** | Comment made while forwarding. | [optional] +**modified** | **datetime** | Time at which approval was forwarded. | [optional] +**forwarder_name** | **str** | Display name of forwarder who forwarded the approval. | [optional] +**reassignment_type** | [**ReassignmentType**](reassignment-type) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_forward_history import ApprovalForwardHistory + +approval_forward_history = ApprovalForwardHistory( +old_approver_name='Frank Mir', +new_approver_name='Al Volta', +comment='Forwarding from Frank to Al', +modified='2019-08-23T18:52:57.398Z', +forwarder_name='William Wilson', +reassignment_type='AUTOMATIC_REASSIGNMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalItemDetails.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..e5271a6ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalItemDetails.md @@ -0,0 +1,45 @@ +--- +id: approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalItemDetails', 'ApprovalItemDetails'] +slug: /tools/sdk/python/v3/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'ApprovalItemDetails'] +--- + +# ApprovalItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval item's ID | [optional] +**account** | **str** | The account referenced by the approval item | [optional] +**application** | **str** | The name of the application/source | [optional] +**name** | **str** | The attribute's name | [optional] +**operation** | **str** | The attribute's operation | [optional] +**value** | **str** | The attribute's value | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_item_details import ApprovalItemDetails + +approval_item_details = ApprovalItemDetails( +id='2c9180835d2e5168015d32f890ca1581', +account='john.smith', +application='Active Directory', +name='emailAddress', +operation='update', +value='a@b.com', +state= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalItems.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalItems.md new file mode 100644 index 000000000..7c208014e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalItems.md @@ -0,0 +1,45 @@ +--- +id: approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalItems', 'ApprovalItems'] +slug: /tools/sdk/python/v3/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'ApprovalItems'] +--- + +# ApprovalItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval item's ID | [optional] +**account** | **str** | The account referenced by the approval item | [optional] +**application** | **str** | The name of the application/source | [optional] +**name** | **str** | The attribute's name | [optional] +**operation** | **str** | The attribute's operation | [optional] +**value** | **str** | The attribute's value | [optional] +**state** | [**WorkItemState**](work-item-state) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_items import ApprovalItems + +approval_items = ApprovalItems( +id='2c9180835d2e5168015d32f890ca1581', +account='john.smith', +application='Active Directory', +name='emailAddress', +operation='update', +value='a@b.com', +state= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..b88810a76 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,43 @@ +--- +id: approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/python/v3/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days_until_escalation** | **int** | 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. | [optional] +**days_between_reminders** | **int** | Number of days to wait between reminder notifications. | [optional] +**max_reminders** | **int** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**fallback_approver_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_reminder_and_escalation_config import ApprovalReminderAndEscalationConfig + +approval_reminder_and_escalation_config = ApprovalReminderAndEscalationConfig( +days_until_escalation=0, +days_between_reminders=0, +max_reminders=1, +fallback_approver_ref=sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalScheme.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalScheme.md new file mode 100644 index 000000000..8a372d2f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalScheme.md @@ -0,0 +1,33 @@ +--- +id: approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalScheme', 'ApprovalScheme'] +slug: /tools/sdk/python/v3/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'ApprovalScheme'] +--- + +# ApprovalScheme + +Describes the individual or group that is responsible for an approval step. + +## Enum + +* `APP_OWNER` (value: `'APP_OWNER'`) + +* `SOURCE_OWNER` (value: `'SOURCE_OWNER'`) + +* `MANAGER` (value: `'MANAGER'`) + +* `ROLE_OWNER` (value: `'ROLE_OWNER'`) + +* `ACCESS_PROFILE_OWNER` (value: `'ACCESS_PROFILE_OWNER'`) + +* `ENTITLEMENT_OWNER` (value: `'ENTITLEMENT_OWNER'`) + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..27d430b52 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalSchemeForRole.md @@ -0,0 +1,35 @@ +--- +id: approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole'] +slug: /tools/sdk/python/v3/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | 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 | [optional] +**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_scheme_for_role import ApprovalSchemeForRole + +approval_scheme_for_role = ApprovalSchemeForRole( +approver_type='GOVERNANCE_GROUP', +approver_id='46c79819-a69f-49a2-becb-12c971ae66c6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatus.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatus.md new file mode 100644 index 000000000..edf644705 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatus', 'ApprovalStatus'] +slug: /tools/sdk/python/v3/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'ApprovalStatus'] +--- + +# ApprovalStatus + +Enum representing the non-employee request approval status + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `PENDING` (value: `'PENDING'`) + +* `NOT_READY` (value: `'NOT_READY'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDto.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..4629e819f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDto.md @@ -0,0 +1,59 @@ +--- +id: approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDto', 'ApprovalStatusDto'] +slug: /tools/sdk/python/v3/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'ApprovalStatusDto'] +--- + +# ApprovalStatusDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_id** | **str** | Unique identifier for the approval. | [optional] +**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False] +**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**modified** | **datetime** | Time at which item was modified. | [optional] +**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**scheme** | [**ApprovalScheme**](approval-scheme) | | [optional] +**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**comment** | **str** | Comment, if any, provided by the approver. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_status_dto import ApprovalStatusDto + +approval_status_dto = ApprovalStatusDto( +approval_id='2c9180877b2b6ea4017b2c545f971429', +forwarded=False, +original_owner=sailpoint.v3.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +current_owner=, +modified='2019-08-23T18:52:57.398Z', +status='PENDING', +scheme='MANAGER', +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.', ) + ], +comment='I approve this request', +remove_date='2020-07-11T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..c6f6b8011 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,37 @@ +--- +id: approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/python/v3/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional] +**id** | **str** | ID of identity who reviewed the access item request. | [optional] +**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_status_dto_current_owner import ApprovalStatusDtoCurrentOwner + +approval_status_dto_current_owner = ApprovalStatusDtoCurrentOwner( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..b86cf6e13 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,38 @@ +--- +id: approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/python/v3/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +Identity of orginal approval owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original approval owner's identity. | [optional] +**id** | **str** | ID of original approval owner's identity. | [optional] +**name** | **str** | Display name of original approval owner. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_status_dto_original_owner import ApprovalStatusDtoOriginalOwner + +approval_status_dto_original_owner = ApprovalStatusDtoOriginalOwner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ApprovalSummary.md b/docs/tools/sdk/python/Reference/V3/Models/ApprovalSummary.md new file mode 100644 index 000000000..b941336cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ApprovalSummary.md @@ -0,0 +1,37 @@ +--- +id: approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ApprovalSummary', 'ApprovalSummary'] +slug: /tools/sdk/python/v3/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'ApprovalSummary'] +--- + +# ApprovalSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pending** | **int** | The number of pending access requests approvals. | [optional] +**approved** | **int** | The number of approved access requests approvals. | [optional] +**rejected** | **int** | The number of rejected access requests approvals. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.approval_summary import ApprovalSummary + +approval_summary = ApprovalSummary( +pending=0, +approved=0, +rejected=0 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ArrayInner.md b/docs/tools/sdk/python/Reference/V3/Models/ArrayInner.md new file mode 100644 index 000000000..88a20ba49 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ArrayInner.md @@ -0,0 +1,31 @@ +--- +id: array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ArrayInner', 'ArrayInner'] +slug: /tools/sdk/python/v3/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'ArrayInner'] +--- + +# ArrayInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v3.models.array_inner import ArrayInner + +array_inner = ArrayInner( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDTO.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDTO.md new file mode 100644 index 000000000..0d76eb27c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDTO.md @@ -0,0 +1,52 @@ +--- +id: attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDTO', 'AttributeDTO'] +slug: /tools/sdk/python/v3/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'AttributeDTO'] +--- + +# AttributeDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**name** | **str** | The display name of the key. | [optional] +**multiselect** | **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to False] +**status** | **str** | The status of the Attribute. | [optional] +**type** | **str** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**object_types** | **[]str** | 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. | [optional] +**description** | **str** | The description of the Attribute. | [optional] +**values** | [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.attribute_dto import AttributeDTO + +attribute_dto = AttributeDTO( +key='iscPrivacy', +name='Privacy', +multiselect=False, +status='active', +type='governance', +object_types=[entitlement], +description='Specifies the level of privacy associated with an access item.', +values=[ + sailpoint.v3.models.attribute_value_dto.AttributeValueDTO( + value = 'public', + name = 'Public', + status = 'active', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDTOList.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDTOList.md new file mode 100644 index 000000000..1bec0bc9e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDTOList.md @@ -0,0 +1,33 @@ +--- +id: attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDTOList', 'AttributeDTOList'] +slug: /tools/sdk/python/v3/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'AttributeDTOList'] +--- + +# AttributeDTOList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.attribute_dto_list import AttributeDTOList + +attribute_dto_list = AttributeDTOList( +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}]}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinition.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinition.md new file mode 100644 index 000000000..c660deeee --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinition.md @@ -0,0 +1,48 @@ +--- +id: attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinition', 'AttributeDefinition'] +slug: /tools/sdk/python/v3/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'AttributeDefinition'] +--- + +# AttributeDefinition + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the attribute. | [optional] +**type** | [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**var_schema** | [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**description** | **str** | A human-readable description of the attribute. | [optional] +**is_multi** | **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to False] +**is_entitlement** | **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to False] +**is_group** | **bool** | 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.. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.attribute_definition import AttributeDefinition + +attribute_definition = AttributeDefinition( +name='sAMAccountName', +type='STRING', +var_schema=sailpoint.v3.models.attribute_definition_schema.AttributeDefinition_schema( + type = 'CONNECTOR_SCHEMA', + id = '2c91808568c529c60168cca6f90c1313', + name = 'group', ), +description='SAM Account Name', +is_multi=False, +is_entitlement=False, +is_group=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..2dccea042 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionSchema.md @@ -0,0 +1,38 @@ +--- +id: attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema'] +slug: /tools/sdk/python/v3/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +A reference to the schema on the source to the attribute values map to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | The type of object being referenced | [optional] +**id** | **str** | The object ID this reference applies to. | [optional] +**name** | **str** | The human-readable display name of the object. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.attribute_definition_schema import AttributeDefinitionSchema + +attribute_definition_schema = AttributeDefinitionSchema( +type='CONNECTOR_SCHEMA', +id='2c91808568c529c60168cca6f90c1313', +name='group' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..bee04f772 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeDefinitionType', 'AttributeDefinitionType'] +slug: /tools/sdk/python/v3/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeDefinitionType'] +--- + +# AttributeDefinitionType + +The underlying type of the value which an AttributeDefinition represents. + +## Enum + +* `STRING` (value: `'STRING'`) + +* `LONG` (value: `'LONG'`) + +* `INT` (value: `'INT'`) + +* `BOOLEAN` (value: `'BOOLEAN'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeRequest.md new file mode 100644 index 000000000..c296afb12 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeRequest.md @@ -0,0 +1,37 @@ +--- +id: attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeRequest', 'AttributeRequest'] +slug: /tools/sdk/python/v3/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'AttributeRequest'] +--- + +# AttributeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Attribute name. | [optional] +**op** | **str** | Operation to perform on attribute. | [optional] +**value** | [**AttributeRequestValue**](attribute-request-value) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.attribute_request import AttributeRequest + +attribute_request = AttributeRequest( +name='groups', +op='Add', +value= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeRequestValue.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeRequestValue.md new file mode 100644 index 000000000..446a38649 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeRequestValue.md @@ -0,0 +1,32 @@ +--- +id: attribute-request-value +title: AttributeRequestValue +pagination_label: AttributeRequestValue +sidebar_label: AttributeRequestValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeRequestValue', 'AttributeRequestValue'] +slug: /tools/sdk/python/v3/models/attribute-request-value +tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'AttributeRequestValue'] +--- + +# AttributeRequestValue + +Value of attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v3.models.attribute_request_value import AttributeRequestValue + +attribute_request_value = AttributeRequestValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeValueDTO.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeValueDTO.md new file mode 100644 index 000000000..43bcee88c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeValueDTO.md @@ -0,0 +1,37 @@ +--- +id: attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AttributeValueDTO', 'AttributeValueDTO'] +slug: /tools/sdk/python/v3/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'AttributeValueDTO'] +--- + +# AttributeValueDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**name** | **str** | The display name of the Attribute value. | [optional] +**status** | **str** | The status of the Attribute value. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.attribute_value_dto import AttributeValueDTO + +attribute_value_dto = AttributeValueDTO( +value='public', +name='Public', +status='active' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AuthUser.md b/docs/tools/sdk/python/Reference/V3/Models/AuthUser.md new file mode 100644 index 000000000..bfae90cfd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AuthUser.md @@ -0,0 +1,69 @@ +--- +id: auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AuthUser', 'AuthUser'] +slug: /tools/sdk/python/v3/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'AuthUser'] +--- + +# AuthUser + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenant** | **str** | Tenant name. | [optional] +**id** | **str** | Identity ID. | [optional] +**uid** | **str** | Identity's unique identitifier. | [optional] +**profile** | **str** | ID of the auth profile associated with the auth user. | [optional] +**identification_number** | **str** | Auth user's employee number. | [optional] +**email** | **str** | Auth user's email. | [optional] +**phone** | **str** | Auth user's phone number. | [optional] +**work_phone** | **str** | Auth user's work phone number. | [optional] +**personal_email** | **str** | Auth user's personal email. | [optional] +**firstname** | **str** | Auth user's first name. | [optional] +**lastname** | **str** | Auth user's last name. | [optional] +**display_name** | **str** | Auth user's name in displayed format. | [optional] +**alias** | **str** | Auth user's alias. | [optional] +**last_password_change_date** | **datetime** | Date of last password change. | [optional] +**last_login_timestamp** | **int** | Timestamp of the last login (long type value). | [optional] +**current_login_timestamp** | **int** | Timestamp of the current login (long type value). | [optional] +**last_unlock_timestamp** | **datetime** | The date and time when the user was last unlocked. | [optional] +**capabilities** | **[]str** | Array of the auth user's capabilities. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.auth_user import AuthUser + +auth_user = AuthUser( +tenant='test-tenant', +id='2c91808458ae7a4f0158b1bbf8af0628', +uid='will.smith', +profile='2c91808458ae7a4f0158b1bbf8af0756', +identification_number='19-5588452', +email='william.smith@example.com', +phone='5555555555', +work_phone='5555555555', +personal_email='william.smith@example.com', +firstname='Will', +lastname='Smith', +display_name='Will Smith', +alias='will.smith', +last_password_change_date='2021-03-08T22:37:33.901Z', +last_login_timestamp=1656327185832, +current_login_timestamp=1656327185832, +last_unlock_timestamp='2021-03-08T22:37:33.901Z', +capabilities=[ + 'ORG_ADMIN' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BackupOptions.md b/docs/tools/sdk/python/Reference/V3/Models/BackupOptions.md new file mode 100644 index 000000000..38dbdfee4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BackupOptions.md @@ -0,0 +1,38 @@ +--- +id: backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BackupOptions', 'BackupOptions'] +slug: /tools/sdk/python/v3/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'BackupOptions'] +--- + +# BackupOptions + +Backup options control what will be included in the backup. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**include_types** | **[]str** | Object type names to be included in a Configuration Hub backup command. | [optional] +**object_options** | [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.backup_options import BackupOptions + +backup_options = BackupOptions( +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BackupResponse.md b/docs/tools/sdk/python/Reference/V3/Models/BackupResponse.md new file mode 100644 index 000000000..28e095bd2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BackupResponse.md @@ -0,0 +1,69 @@ +--- +id: backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BackupResponse', 'BackupResponse'] +slug: /tools/sdk/python/v3/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'BackupResponse'] +--- + +# BackupResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this backup. | [optional] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the backup. | [optional] +**type** | **Enum** [ 'BACKUP' ] | Type of the job, will always be BACKUP for this type of job. | [optional] +**tenant** | **str** | The name of the tenant performing the upload | [optional] +**requester_name** | **str** | The name of the requester. | [optional] +**file_exists** | **bool** | Whether or not a file was created and stored for this backup. | [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** | The name assigned to the upload file in the request body. | [optional] +**user_can_delete** | **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to True] +**is_partial** | **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to False] +**backup_type** | **Enum** [ 'UPLOADED', 'AUTOMATED', 'MANUAL' ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**options** | [**BackupOptions**](backup-options) | | [optional] +**hydration_status** | **Enum** [ 'HYDRATED', 'NOT_HYDRATED' ] | Whether the object details of this backup are ready. | [optional] +**total_object_count** | **int** | Number of objects contained in this backup. | [optional] +**cloud_storage_status** | **Enum** [ 'SYNCED', 'NOT_SYNCED', 'SYNC_FAILED' ] | Whether this backup has been transferred to a customer storage location. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.backup_response import BackupResponse + +backup_response = BackupResponse( +job_id='3469b87d-48ca-439a-868f-2160001da8c1', +status='COMPLETE', +type='BACKUP', +tenant='tenant-name', +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='Backup Name', +user_can_delete=False, +is_partial=False, +backup_type='MANUAL', +options=sailpoint.v3.models.backup_options.BackupOptions( + include_types = [ + 'TRIGGER_SUBSCRIPTION' + ], + object_options = {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}}, ), +hydration_status='NOT_HYDRATED', +total_object_count=10, +cloud_storage_status='SYNCED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseAccess.md b/docs/tools/sdk/python/Reference/V3/Models/BaseAccess.md new file mode 100644 index 000000000..2f7e25aff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseAccess.md @@ -0,0 +1,51 @@ +--- +id: base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccess', 'BaseAccess'] +slug: /tools/sdk/python/v3/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess'] +--- + +# BaseAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Access item's description. | [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] +**synced** | **datetime** | 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] +**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False] +**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True] +**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False] +**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.base_access import BaseAccess + +base_access = BaseAccess( +description='Admin access', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:33.104Z', +enabled=True, +requestable=True, +request_comments_required=False, +owner=sailpoint.v3.models.base_access_owner.BaseAccess_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', + email = 'cloud-support@sailpoint.com', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseAccessOwner.md b/docs/tools/sdk/python/Reference/V3/Models/BaseAccessOwner.md new file mode 100644 index 000000000..27d9380a8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseAccessOwner.md @@ -0,0 +1,40 @@ +--- +id: base-access-owner +title: BaseAccessOwner +pagination_label: BaseAccessOwner +sidebar_label: BaseAccessOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccessOwner', 'BaseAccessOwner'] +slug: /tools/sdk/python/v3/models/base-access-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'BaseAccessOwner'] +--- + +# BaseAccessOwner + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's display name. | [optional] +**email** | **str** | Owner's email. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.base_access_owner import BaseAccessOwner + +base_access_owner = BaseAccessOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support', +email='cloud-support@sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseAccessProfile.md b/docs/tools/sdk/python/Reference/V3/Models/BaseAccessProfile.md new file mode 100644 index 000000000..2d14590e0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseAccessProfile.md @@ -0,0 +1,35 @@ +--- +id: base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccessProfile', 'BaseAccessProfile'] +slug: /tools/sdk/python/v3/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'BaseAccessProfile'] +--- + +# BaseAccessProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Access profile's unique ID. | [optional] +**name** | **str** | Access profile's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.base_access_profile import BaseAccessProfile + +base_access_profile = BaseAccessProfile( +id='2c91809c6faade77016fb4f0b63407ae', +name='Admin Access' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseAccount.md b/docs/tools/sdk/python/Reference/V3/Models/BaseAccount.md new file mode 100644 index 000000000..0dd871b38 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseAccount.md @@ -0,0 +1,57 @@ +--- +id: base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseAccount', 'BaseAccount'] +slug: /tools/sdk/python/v3/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'BaseAccount'] +--- + +# BaseAccount + + +## 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] +**account_id** | **str** | Account ID. | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +**disabled** | **bool** | Indicates whether the account is disabled. | [optional] [default to False] +**locked** | **bool** | Indicates whether the account is locked. | [optional] [default to False] +**privileged** | **bool** | Indicates whether the account is privileged. | [optional] [default to False] +**manually_correlated** | **bool** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to False] +**password_last_set** | **datetime** | A date-time in ISO-8601 format | [optional] +**entitlement_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**supports_password_change** | **bool** | Indicates whether the account supports password change. | [optional] [default to False] +**account_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.base_account import BaseAccount + +base_account = BaseAccount( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +account_id='John.Doe', +source=, +disabled=False, +locked=False, +privileged=False, +manually_correlated=False, +password_last_set='2018-06-25T20:22:28.104Z', +entitlement_attributes={moderator=true, admin=true, trust_level=4}, +created='2018-06-25T20:22:28.104Z', +supports_password_change=False, +account_attributes={type=global, admin=true, trust_level=4} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseCommonDto.md b/docs/tools/sdk/python/Reference/V3/Models/BaseCommonDto.md new file mode 100644 index 000000000..491f72c83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseCommonDto.md @@ -0,0 +1,39 @@ +--- +id: base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseCommonDto', 'BaseCommonDto'] +slug: /tools/sdk/python/v3/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BaseCommonDto'] +--- + +# BaseCommonDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.base_common_dto import BaseCommonDto + +base_common_dto = BaseCommonDto( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseDocument.md b/docs/tools/sdk/python/Reference/V3/Models/BaseDocument.md new file mode 100644 index 000000000..c371043f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseDocument.md @@ -0,0 +1,35 @@ +--- +id: base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseDocument', 'BaseDocument'] +slug: /tools/sdk/python/v3/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument'] +--- + +# BaseDocument + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the referenced object. | [required] +**name** | **str** | The human readable name of the referenced object. | [required] +} + +## Example + +```python +from sailpoint.v3.models.base_document import BaseDocument + +base_document = BaseDocument( +id='2c91808375d8e80a0175e1f88a575222', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseEntitlement.md b/docs/tools/sdk/python/Reference/V3/Models/BaseEntitlement.md new file mode 100644 index 000000000..8a58b9805 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseEntitlement.md @@ -0,0 +1,47 @@ +--- +id: base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseEntitlement', 'BaseEntitlement'] +slug: /tools/sdk/python/v3/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'BaseEntitlement'] +--- + +# BaseEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False] +**description** | **str** | Entitlement's description. | [optional] +**attribute** | **str** | Entitlement attribute's name. | [optional] +**value** | **str** | Entitlement's value. | [optional] +**var_schema** | **str** | Entitlement's schema. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.base_entitlement import BaseEntitlement + +base_entitlement = BaseEntitlement( +has_permissions=False, +description='Cloud engineering', +attribute='memberOf', +value='CN=Cloud Engineering,DC=sailpoint,DC=COM', +var_schema='group', +privileged=False, +id='2c918084575812550157589064f33b89', +name='CN=Cloud Engineering,DC=sailpoint,DC=COM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseReferenceDto.md b/docs/tools/sdk/python/Reference/V3/Models/BaseReferenceDto.md new file mode 100644 index 000000000..adf4c556a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseReferenceDto.md @@ -0,0 +1,37 @@ +--- +id: base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto', 'BaseReferenceDto'] +slug: /tools/sdk/python/v3/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BaseReferenceDto'] +--- + +# BaseReferenceDto + + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.base_reference_dto import BaseReferenceDto + +base_reference_dto = BaseReferenceDto( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BaseSegment.md b/docs/tools/sdk/python/Reference/V3/Models/BaseSegment.md new file mode 100644 index 000000000..dacce4c48 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BaseSegment.md @@ -0,0 +1,35 @@ +--- +id: base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BaseSegment', 'BaseSegment'] +slug: /tools/sdk/python/v3/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'BaseSegment'] +--- + +# BaseSegment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Segment's unique ID. | [optional] +**name** | **str** | Segment's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.base_segment import BaseSegment + +base_segment = BaseSegment( +id='b009b6e3-b56d-41d9-8735-cb532ea0b017', +name='Test Segment' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/python/Reference/V3/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..4e6065364 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,38 @@ +--- +id: before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto'] +slug: /tools/sdk/python/v3/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +Before Provisioning Rule. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Before Provisioning Rule DTO type. | [optional] +**id** | **str** | Before Provisioning Rule ID. | [optional] +**name** | **str** | Rule display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.before_provisioning_rule_dto import BeforeProvisioningRuleDto + +before_provisioning_rule_dto = BeforeProvisioningRuleDto( +type='RULE', +id='048eb3d55c5a4758bd07dccb87741c78', +name='Before Provisioning Airtable Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Bound.md b/docs/tools/sdk/python/Reference/V3/Models/Bound.md new file mode 100644 index 000000000..03284550c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Bound.md @@ -0,0 +1,35 @@ +--- +id: bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Bound', 'Bound'] +slug: /tools/sdk/python/v3/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'Bound'] +--- + +# Bound + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The value of the range's endpoint. | [required] +**inclusive** | **bool** | Indicates if the endpoint is included in the range. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.bound import Bound + +bound = Bound( +value='1', +inclusive=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BrandingItem.md b/docs/tools/sdk/python/Reference/V3/Models/BrandingItem.md new file mode 100644 index 000000000..8160acc5d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BrandingItem.md @@ -0,0 +1,47 @@ +--- +id: branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BrandingItem', 'BrandingItem'] +slug: /tools/sdk/python/v3/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'BrandingItem'] +--- + +# BrandingItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | name of branding item | [optional] +**product_name** | **str** | product name | [optional] +**action_button_color** | **str** | hex value of color for action button | [optional] +**active_link_color** | **str** | hex value of color for link | [optional] +**navigation_color** | **str** | hex value of color for navigation bar | [optional] +**email_from_address** | **str** | email from address | [optional] +**standard_logo_url** | **str** | url to standard logo | [optional] +**login_informational_message** | **str** | login information message | [optional] +} + +## Example + +```python +from sailpoint.v3.models.branding_item import BrandingItem + +branding_item = BrandingItem( +name='default', +product_name='product name', +action_button_color='0074D9', +active_link_color='011E69', +navigation_color='011E69', +email_from_address='no-reply@sailpoint.com', +standard_logo_url='', +login_informational_message='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BrandingItemCreate.md b/docs/tools/sdk/python/Reference/V3/Models/BrandingItemCreate.md new file mode 100644 index 000000000..379c0641c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BrandingItemCreate.md @@ -0,0 +1,47 @@ +--- +id: branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BrandingItemCreate', 'BrandingItemCreate'] +slug: /tools/sdk/python/v3/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'BrandingItemCreate'] +--- + +# BrandingItemCreate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | name of branding item | [required] +**product_name** | **str** | product name | [required] +**action_button_color** | **str** | hex value of color for action button | [optional] +**active_link_color** | **str** | hex value of color for link | [optional] +**navigation_color** | **str** | hex value of color for navigation bar | [optional] +**email_from_address** | **str** | email from address | [optional] +**login_informational_message** | **str** | login information message | [optional] +**file_standard** | **bytearray** | png file with logo | [optional] +} + +## Example + +```python +from sailpoint.v3.models.branding_item_create import BrandingItemCreate + +branding_item_create = BrandingItemCreate( +name='custom-branding-item', +product_name='product name', +action_button_color='0074D9', +active_link_color='011E69', +navigation_color='011E69', +email_from_address='no-reply@sailpoint.com', +login_informational_message='', +file_standard='\x00\x00\x00\x02' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BucketAggregation.md b/docs/tools/sdk/python/Reference/V3/Models/BucketAggregation.md new file mode 100644 index 000000000..19e9d5c7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BucketAggregation.md @@ -0,0 +1,42 @@ +--- +id: bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BucketAggregation', 'BucketAggregation'] +slug: /tools/sdk/python/v3/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'BucketAggregation'] +--- + +# BucketAggregation + +The bucket to group the results of the aggregation query by. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the bucket aggregate to be included in the result. | [required] +**type** | [**BucketType**](bucket-type) | | [optional] [default to BucketType.TERMS] +**var_field** | **str** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required] +**size** | **int** | Maximum number of buckets to include. | [optional] +**min_doc_count** | **int** | Minimum number of documents a bucket should have. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.bucket_aggregation import BucketAggregation + +bucket_aggregation = BucketAggregation( +name='Identity Locations', +type='TERMS', +var_field='attributes.city', +size=100, +min_doc_count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BucketType.md b/docs/tools/sdk/python/Reference/V3/Models/BucketType.md new file mode 100644 index 000000000..0e1c5f77c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BucketType.md @@ -0,0 +1,21 @@ +--- +id: bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BucketType', 'BucketType'] +slug: /tools/sdk/python/v3/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'BucketType'] +--- + +# BucketType + +Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. + +## Enum + +* `TERMS` (value: `'TERMS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BulkAddTaggedObject.md b/docs/tools/sdk/python/Reference/V3/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..5c81ea19e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BulkAddTaggedObject.md @@ -0,0 +1,42 @@ +--- +id: bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkAddTaggedObject', 'BulkAddTaggedObject'] +slug: /tools/sdk/python/v3/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'BulkAddTaggedObject'] +--- + +# BulkAddTaggedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to an Object | [optional] +**operation** | **Enum** [ 'APPEND', 'MERGE' ] | 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. | [optional] [default to 'APPEND'] +} + +## Example + +```python +from sailpoint.v3.models.bulk_add_tagged_object import BulkAddTaggedObject + +bulk_add_tagged_object = BulkAddTaggedObject( +object_refs=[ + sailpoint.v3.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI], +operation='APPEND' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/python/Reference/V3/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..68d87be84 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,40 @@ +--- +id: bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkRemoveTaggedObject', 'BulkRemoveTaggedObject'] +slug: /tools/sdk/python/v3/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'BulkRemoveTaggedObject'] +--- + +# BulkRemoveTaggedObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.bulk_remove_tagged_object import BulkRemoveTaggedObject + +bulk_remove_tagged_object = BulkRemoveTaggedObject( +object_refs=[ + sailpoint.v3.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/python/Reference/V3/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..209afcabb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,40 @@ +--- +id: bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'BulkTaggedObjectResponse', 'BulkTaggedObjectResponse'] +slug: /tools/sdk/python/v3/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'BulkTaggedObjectResponse'] +--- + +# BulkTaggedObjectResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_refs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Label to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.bulk_tagged_object_response import BulkTaggedObjectResponse + +bulk_tagged_object_response = BulkTaggedObjectResponse( +object_refs=[ + sailpoint.v3.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Campaign.md b/docs/tools/sdk/python/Reference/V3/Models/Campaign.md new file mode 100644 index 000000000..58819d748 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Campaign.md @@ -0,0 +1,122 @@ +--- +id: campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Campaign', 'Campaign'] +slug: /tools/sdk/python/v3/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'Campaign'] +--- + +# Campaign + + +## 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.campaign import Campaign + +campaign = Campaign( +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/CampaignAlert.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAlert.md new file mode 100644 index 000000000..fcc2e9f1c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAlert.md @@ -0,0 +1,40 @@ +--- +id: campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAlert', 'CampaignAlert'] +slug: /tools/sdk/python/v3/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'CampaignAlert'] +--- + +# CampaignAlert + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**level** | **Enum** [ 'ERROR', 'WARN', 'INFO' ] | Denotes the level of the message | [optional] +**localizations** | [**[]ErrorMessageDto**](error-message-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_alert import CampaignAlert + +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.', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfFilter.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..1cdd22732 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfFilter.md @@ -0,0 +1,38 @@ +--- +id: campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfFilter', 'CampaignAllOfFilter'] +slug: /tools/sdk/python/v3/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'CampaignAllOfFilter'] +--- + +# CampaignAllOfFilter + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of whatever type of filter is being used. | [optional] +**type** | **Enum** [ 'CAMPAIGN_FILTER', 'RULE' ] | Type of the filter | [optional] +**name** | **str** | Name of the filter | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_filter import CampaignAllOfFilter + +campaign_all_of_filter = CampaignAllOfFilter( +id='0fbe863c063c4c88a35fd7f17e8a3df5', +type='CAMPAIGN_FILTER', +name='Test Filter' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..4fb1b8114 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,36 @@ +--- +id: campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/python/v3/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'CampaignAllOfMachineAccountCampaignInfo'] +--- + +# CampaignAllOfMachineAccountCampaignInfo + +Must be set only if the campaign type is MACHINE_ACCOUNT. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_ids** | **[]str** | The list of sources to be included in the campaign. | [optional] +**reviewer_type** | **Enum** [ 'ACCOUNT_OWNER' ] | The reviewer's type. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_machine_account_campaign_info import CampaignAllOfMachineAccountCampaignInfo + +campaign_all_of_machine_account_campaign_info = CampaignAllOfMachineAccountCampaignInfo( +source_ids=[0fbe863c063c4c88a35fd7f17e8a3df5], +reviewer_type='ACCOUNT_OWNER' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..ede0b25a4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,48 @@ +--- +id: campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/python/v3/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'CampaignAllOfRoleCompositionCampaignInfo'] +--- + +# CampaignAllOfRoleCompositionCampaignInfo + +Optional configuration options for role composition campaigns. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reviewer** | [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**role_ids** | **[]str** | 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. | [optional] +**remediator_ref** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] +**query** | **str** | 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. | [optional] +**description** | **str** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_role_composition_campaign_info import CampaignAllOfRoleCompositionCampaignInfo + +campaign_all_of_role_composition_campaign_info = CampaignAllOfRoleCompositionCampaignInfo( +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..18a5c33b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,38 @@ +--- +id: campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/python/v3/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Legal Remediator Type | [required] +**id** | **str** | The ID of the remediator. | [required] +**name** | **str** | The name of the remediator. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_role_composition_campaign_info_remediator_ref import CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +campaign_all_of_role_composition_campaign_info_remediator_ref = CampaignAllOfRoleCompositionCampaignInfoRemediatorRef( +type='IDENTITY', +id='2c90ad2a70ace7d50170acf22ca90010', +name='Role Admin' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..8cf5c826e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,52 @@ +--- +id: campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/python/v3/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'CampaignAllOfSearchCampaignInfo'] +--- + +# CampaignAllOfSearchCampaignInfo + +Must be set only if the campaign type is SEARCH. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'ACCESS' ] | The type of search campaign represented. | [required] +**description** | **str** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**reviewer** | [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**query** | **str** | 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. | [optional] +**identity_ids** | **[]str** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**access_constraints** | [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_search_campaign_info import CampaignAllOfSearchCampaignInfo + +campaign_all_of_search_campaign_info = CampaignAllOfSearchCampaignInfo( +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', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..52b4d134b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,38 @@ +--- +id: campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/python/v3/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'CampaignAllOfSearchCampaignInfoReviewer'] +--- + +# CampaignAllOfSearchCampaignInfoReviewer + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | The reviewer's DTO type. | [optional] +**id** | **str** | The reviewer's ID. | [optional] +**name** | **str** | The reviewer's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer import CampaignAllOfSearchCampaignInfoReviewer + +campaign_all_of_search_campaign_info_reviewer = CampaignAllOfSearchCampaignInfoReviewer( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..1d9b763e2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,34 @@ +--- +id: campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/python/v3/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'CampaignAllOfSourceOwnerCampaignInfo'] +--- + +# CampaignAllOfSourceOwnerCampaignInfo + +Must be set only if the campaign type is SOURCE_OWNER. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_ids** | **[]str** | The list of sources to be included in the campaign. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_source_owner_campaign_info import CampaignAllOfSourceOwnerCampaignInfo + +campaign_all_of_source_owner_campaign_info = CampaignAllOfSourceOwnerCampaignInfo( +source_ids=[0fbe863c063c4c88a35fd7f17e8a3df5] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..bbb455c84 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,37 @@ +--- +id: campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/python/v3/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'CampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# CampaignAllOfSourcesWithOrphanEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the source | [optional] +**type** | **Enum** [ 'SOURCE' ] | Type | [optional] +**name** | **str** | Name of the source | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_all_of_sources_with_orphan_entitlements import CampaignAllOfSourcesWithOrphanEntitlements + +campaign_all_of_sources_with_orphan_entitlements = CampaignAllOfSourcesWithOrphanEntitlements( +id='2c90ad2a70ace7d50170acf22ca90010', +type='SOURCE', +name='Source with orphan entitlements' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignCompleteOptions.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..b7ff0f306 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignCompleteOptions.md @@ -0,0 +1,33 @@ +--- +id: campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignCompleteOptions', 'CampaignCompleteOptions'] +slug: /tools/sdk/python/v3/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'CampaignCompleteOptions'] +--- + +# CampaignCompleteOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto_complete_action** | **Enum** [ 'APPROVE', 'REVOKE' ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to 'APPROVE'] +} + +## Example + +```python +from sailpoint.v3.models.campaign_complete_options import CampaignCompleteOptions + +campaign_complete_options = CampaignCompleteOptions( +auto_complete_action='APPROVE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetails.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..88fce22dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetails.md @@ -0,0 +1,46 @@ +--- +id: campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignFilterDetails', 'CampaignFilterDetails'] +slug: /tools/sdk/python/v3/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'CampaignFilterDetails'] +--- + +# CampaignFilterDetails + +Campaign Filter Details + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign filter | [required] +**name** | **str** | Campaign filter name. | [required] +**description** | **str** | Campaign filter description. | [optional] +**owner** | **str** | Owner of the filter. This field automatically populates at creation time with the current user. | [required] +**mode** | **Enum** [ 'INCLUSION', 'EXCLUSION' ] | 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. | [required] +**criteria_list** | [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**is_system_filter** | **bool** | If true, the filter is created by the system. If false, the filter is created by a user. | [required][default to False] +} + +## Example + +```python +from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails + +campaign_filter_details = CampaignFilterDetails( +id='5ec18cef39020d6fd7a60ad3970aba61', +name='Identity Attribute Campaign Filter', +description='Campaign filter to certify data based on an identity attribute's specified property.', +owner='SailPoint Support', +mode=INCLUSION, +criteria_list=[{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}], +is_system_filter=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..a948cbf81 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,39 @@ +--- +id: campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/python/v3/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'CampaignFilterDetailsCriteriaListInner'] +--- + +# CampaignFilterDetailsCriteriaListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**CriteriaType**](criteria-type) | | [required] +**operation** | [**Operation**](operation) | | [required] +**var_property** | **str** | Specified key from the type of criteria. | [required] +**value** | **str** | Value for the specified key from the type of criteria. | [required] +} + +## Example + +```python +from sailpoint.v3.models.campaign_filter_details_criteria_list_inner import CampaignFilterDetailsCriteriaListInner + +campaign_filter_details_criteria_list_inner = CampaignFilterDetailsCriteriaListInner( +type='IDENTITY_ATTRIBUTE', +operation=, +var_property='displayName', +value='Allie' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignReference.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignReference.md new file mode 100644 index 000000000..b7685e66a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignReference.md @@ -0,0 +1,45 @@ +--- +id: campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReference', 'CampaignReference'] +slug: /tools/sdk/python/v3/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'CampaignReference'] +--- + +# CampaignReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the campaign. | [required] +**name** | **str** | The name of the campaign. | [required] +**type** | **Enum** [ 'CAMPAIGN' ] | The type of object that is being referenced. | [required] +**campaign_type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH' ] | The type of the campaign. | [required] +**description** | **str** | The description of the campaign set by the admin who created it. | [required] +**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). | [required] +**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. | [required] +} + +## Example + +```python +from sailpoint.v3.models.campaign_reference import CampaignReference + +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignReport.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignReport.md new file mode 100644 index 000000000..06117df1a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignReport.md @@ -0,0 +1,43 @@ +--- +id: campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReport', 'CampaignReport'] +slug: /tools/sdk/python/v3/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'CampaignReport'] +--- + +# CampaignReport + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +**status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR', 'PENDING' ] | Status of a SOD policy violation report. | [optional] +**report_type** | [**ReportType**](report-type) | | [required] +**last_run_at** | **datetime** | The most recent date and time this report was run | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.campaign_report import CampaignReport + +campaign_report = CampaignReport( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation', +status='PENDING', +report_type='CAMPAIGN_COMPOSITION_REPORT', +last_run_at=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignReportsConfig.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..da2a1b25d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignReportsConfig.md @@ -0,0 +1,33 @@ +--- +id: campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignReportsConfig', 'CampaignReportsConfig'] +slug: /tools/sdk/python/v3/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'CampaignReportsConfig'] +--- + +# CampaignReportsConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attribute_columns** | **[]str** | list of identity attribute columns | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig + +campaign_reports_config = CampaignReportsConfig( +identity_attribute_columns=[firstname, lastname] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignTemplate.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignTemplate.md new file mode 100644 index 000000000..668d6faba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignTemplate.md @@ -0,0 +1,54 @@ +--- +id: campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignTemplate', 'CampaignTemplate'] +slug: /tools/sdk/python/v3/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'CampaignTemplate'] +--- + +# CampaignTemplate + +Campaign Template + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign template | [optional] +**name** | **str** | This template's name. Has no bearing on generated campaigns' names. | [required] +**description** | **str** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] +**created** | **datetime** | Creation date of Campaign Template | [required][readonly] +**modified** | **datetime** | Modification date of Campaign Template | [required][readonly] +**scheduled** | **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to False] +**owner_ref** | [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**deadline_duration** | **str** | 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). | [optional] +**campaign** | [**Campaign**](campaign) | | [required] +} + +## Example + +```python +from sailpoint.v3.models.campaign_template import CampaignTemplate + +campaign_template = CampaignTemplate( +id='2c9079b270a266a60170a277bb960008', +name='Manager Campaign Template', +description='Template for the annual manager campaign.', +created='2020-03-05T22:44:00.364Z', +modified='2020-03-05T22:52:09.969Z', +scheduled=False, +owner_ref=sailpoint.v3.models.campaign_template_owner_ref.CampaignTemplate_ownerRef( + id = '2c918086676d3e0601677611dbde220f', + type = 'IDENTITY', + name = 'Mister Manager', + email = 'mr.manager@example.com', ), +deadline_duration='P2W', +campaign=sailpoint.v3.models.campaign.Campaign() +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..16fdef880 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,40 @@ +--- +id: campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignTemplateOwnerRef', 'CampaignTemplateOwnerRef'] +slug: /tools/sdk/python/v3/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'CampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the owner | [optional] +**type** | **Enum** [ 'IDENTITY' ] | Type of the owner | [optional] +**name** | **str** | Name of the owner | [optional] +**email** | **str** | Email of the owner | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaign_template_owner_ref import CampaignTemplateOwnerRef + +campaign_template_owner_ref = CampaignTemplateOwnerRef( +id='2c918086676d3e0601677611dbde220f', +type='IDENTITY', +name='Mister Manager', +email='mr.manager@example.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..3daace852 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CampaignsDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CampaignsDeleteRequest', 'CampaignsDeleteRequest'] +slug: /tools/sdk/python/v3/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'CampaignsDeleteRequest'] +--- + +# CampaignsDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | The ids of the campaigns to delete | [optional] +} + +## Example + +```python +from sailpoint.v3.models.campaigns_delete_request import CampaignsDeleteRequest + +campaigns_delete_request = CampaignsDeleteRequest( +ids=[2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CancelAccessRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CancelAccessRequest.md new file mode 100644 index 000000000..049831e0c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CancelAccessRequest.md @@ -0,0 +1,36 @@ +--- +id: cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelAccessRequest', 'CancelAccessRequest'] +slug: /tools/sdk/python/v3/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'CancelAccessRequest'] +--- + +# CancelAccessRequest + +Request body payload for cancel access request endpoint. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_activity_id** | **str** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] +**comment** | **str** | Reason for cancelling the pending access request. | [required] +} + +## Example + +```python +from sailpoint.v3.models.cancel_access_request import CancelAccessRequest + +cancel_access_request = CancelAccessRequest( +account_activity_id='2c9180835d2e5168015d32f890ca1581', +comment='I requested this role by mistake.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CancelledRequestDetails.md b/docs/tools/sdk/python/Reference/V3/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..c6407e7a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CancelledRequestDetails.md @@ -0,0 +1,41 @@ +--- +id: cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CancelledRequestDetails', 'CancelledRequestDetails'] +slug: /tools/sdk/python/v3/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'CancelledRequestDetails'] +--- + +# CancelledRequestDetails + +Provides additional details for a request that has been cancelled. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.cancelled_request_details import CancelledRequestDetails + +cancelled_request_details = CancelledRequestDetails( +comment='This request must be cancelled.', +owner=sailpoint.v3.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +modified='2019-12-20T09:17:12.192Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Certification.md b/docs/tools/sdk/python/Reference/V3/Models/Certification.md new file mode 100644 index 000000000..216e8456e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Certification.md @@ -0,0 +1,90 @@ +--- +id: certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Certification', 'Certification'] +slug: /tools/sdk/python/v3/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'Certification'] +--- + +# Certification + + +## 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.certification import Certification + +certification = Certification( +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/CertificationDecision.md b/docs/tools/sdk/python/Reference/V3/Models/CertificationDecision.md new file mode 100644 index 000000000..944ae775b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CertificationDecision.md @@ -0,0 +1,23 @@ +--- +id: certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationDecision', 'CertificationDecision'] +slug: /tools/sdk/python/v3/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'CertificationDecision'] +--- + +# CertificationDecision + +The decision to approve or revoke the review item + +## Enum + +* `APPROVE` (value: `'APPROVE'`) + +* `REVOKE` (value: `'REVOKE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CertificationIdentitySummary.md b/docs/tools/sdk/python/Reference/V3/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..c199cdacd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CertificationIdentitySummary.md @@ -0,0 +1,39 @@ +--- +id: certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationIdentitySummary', 'CertificationIdentitySummary'] +slug: /tools/sdk/python/v3/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'CertificationIdentitySummary'] +--- + +# CertificationIdentitySummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the identity summary | [optional] +**name** | **str** | Name of the linked identity | [optional] +**identity_id** | **str** | The ID of the identity being certified | [optional] +**completed** | **bool** | Indicates whether the review items for the linked identity's certification have been completed | [optional] +} + +## Example + +```python +from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + +certification_identity_summary = CertificationIdentitySummary( +id='2c91808772a504f50172a9540e501ba7', +name='Alison Ferguso', +identity_id='2c9180857182306001719937377a33de', +completed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CertificationPhase.md b/docs/tools/sdk/python/Reference/V3/Models/CertificationPhase.md new file mode 100644 index 000000000..e64cf96b9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CertificationPhase.md @@ -0,0 +1,25 @@ +--- +id: certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationPhase', 'CertificationPhase'] +slug: /tools/sdk/python/v3/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'CertificationPhase'] +--- + +# CertificationPhase + +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` (value: `'STAGED'`) + +* `ACTIVE` (value: `'ACTIVE'`) + +* `SIGNED` (value: `'SIGNED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CertificationReference.md b/docs/tools/sdk/python/Reference/V3/Models/CertificationReference.md new file mode 100644 index 000000000..c32185c73 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CertificationReference.md @@ -0,0 +1,45 @@ +--- +id: certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationReference', 'CertificationReference'] +slug: /tools/sdk/python/v3/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'CertificationReference'] +--- + +# CertificationReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the certification. | [optional] +**name** | **str** | The name of the certification. | [optional] +**type** | **Enum** [ 'CERTIFICATION' ] | | [optional] +**reviewer** | [**Reviewer**](reviewer) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.certification_reference import CertificationReference + +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', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CertificationTask.md b/docs/tools/sdk/python/Reference/V3/Models/CertificationTask.md new file mode 100644 index 000000000..8d5ee8133 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CertificationTask.md @@ -0,0 +1,52 @@ +--- +id: certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CertificationTask', 'CertificationTask'] +slug: /tools/sdk/python/v3/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'CertificationTask'] +--- + +# CertificationTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification task. | [optional] +**type** | **Enum** [ 'REASSIGN', 'ADMIN_REASSIGN', 'COMPLETE_CERTIFICATION', 'FINISH_CERTIFICATION', 'COMPLETE_CAMPAIGN', 'ACTIVATE_CAMPAIGN', 'CAMPAIGN_CREATE', 'CAMPAIGN_DELETE' ] | The type of the certification task. More values may be added in the future. | [optional] +**target_type** | **Enum** [ 'CERTIFICATION', 'CAMPAIGN' ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**target_id** | **str** | The ID of the item being operated on by this task. | [optional] +**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The status of the task. | [optional] +**errors** | [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**reassignment_trail_dtos** | [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**created** | **datetime** | The date and time on which this task was created. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.certification_task import CertificationTask + +certification_task = CertificationTask( +id='2c918086719eec070171a7e3355a360a', +type='ADMIN_REASSIGN', +target_type='CAMPAIGN', +target_id='2c918086719eec070171a7e3355a834c', +status='QUEUED', +errors=[ + 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.', ) + ], +reassignment_trail_dtos={previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT}, +created='2020-09-24T18:10:47.693Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfiguration.md b/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..c0a20dc15 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfiguration.md @@ -0,0 +1,42 @@ +--- +id: client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfiguration', 'ClientLogConfiguration'] +slug: /tools/sdk/python/v3/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'ClientLogConfiguration'] +--- + +# ClientLogConfiguration + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**expiration** | **datetime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + +client_log_configuration = ClientLogConfiguration( +client_id='3a38a51992e8445ab51a549c0a70ee66', +duration_minutes=120, +expiration='2024-11-06T01:31:08.013164Z', +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..f2b8b3055 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,40 @@ +--- +id: client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfigurationDurationMinutes', 'ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/python/v3/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'ClientLogConfigurationDurationMinutes'] +--- + +# ClientLogConfigurationDurationMinutes + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.v3.models.client_log_configuration_duration_minutes import ClientLogConfigurationDurationMinutes + +client_log_configuration_duration_minutes = ClientLogConfigurationDurationMinutes( +client_id='3a38a51992e8445ab51a549c0a70ee66', +duration_minutes=120, +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..b72255cb6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,40 @@ +--- +id: client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientLogConfigurationExpiration', 'ClientLogConfigurationExpiration'] +slug: /tools/sdk/python/v3/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'ClientLogConfigurationExpiration'] +--- + +# ClientLogConfigurationExpiration + +Client Runtime Logging Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**expiration** | **datetime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +} + +## Example + +```python +from sailpoint.v3.models.client_log_configuration_expiration import ClientLogConfigurationExpiration + +client_log_configuration_expiration = ClientLogConfigurationExpiration( +client_id='3a38a51992e8445ab51a549c0a70ee66', +expiration='2024-11-06T01:31:08.013164Z', +root_level='INFO', +log_levels=INFO +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ClientType.md b/docs/tools/sdk/python/Reference/V3/Models/ClientType.md new file mode 100644 index 000000000..9287124f6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ClientType.md @@ -0,0 +1,23 @@ +--- +id: client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ClientType', 'ClientType'] +slug: /tools/sdk/python/v3/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'ClientType'] +--- + +# ClientType + +Type of an API Client indicating public or confidentials use + +## Enum + +* `CONFIDENTIAL` (value: `'CONFIDENTIAL'`) + +* `PUBLIC` (value: `'PUBLIC'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Column.md b/docs/tools/sdk/python/Reference/V3/Models/Column.md new file mode 100644 index 000000000..cfa17f10a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Column.md @@ -0,0 +1,35 @@ +--- +id: column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Column', 'Column'] +slug: /tools/sdk/python/v3/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'Column'] +--- + +# Column + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_field** | **str** | The name of the field. | [required] +**header** | **str** | The value of the header. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.column import Column + +column = Column( +var_field='email', +header='Work Email' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Comment.md b/docs/tools/sdk/python/Reference/V3/Models/Comment.md new file mode 100644 index 000000000..55dacd4eb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Comment.md @@ -0,0 +1,39 @@ +--- +id: comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Comment', 'Comment'] +slug: /tools/sdk/python/v3/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'Comment'] +--- + +# Comment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commenter_id** | **str** | Id of the identity making the comment | [optional] +**commenter_name** | **str** | Human-readable display name of the identity making the comment | [optional] +**body** | **str** | Content of the comment | [optional] +**var_date** | **datetime** | Date and time comment was made | [optional] +} + +## Example + +```python +from sailpoint.v3.models.comment import Comment + +comment = Comment( +commenter_id='2c918084660f45d6016617daa9210584', +commenter_name='Adam Kennedy', +body='Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.', +var_date='2017-07-11T18:45:37.098Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CommentDto.md b/docs/tools/sdk/python/Reference/V3/Models/CommentDto.md new file mode 100644 index 000000000..a9176a625 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CommentDto.md @@ -0,0 +1,40 @@ +--- +id: comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDto', 'CommentDto'] +slug: /tools/sdk/python/v3/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'CommentDto'] +--- + +# CommentDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.comment_dto import CommentDto + +comment_dto = CommentDto( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CommentDtoAuthor.md b/docs/tools/sdk/python/Reference/V3/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..e5567d156 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CommentDtoAuthor.md @@ -0,0 +1,38 @@ +--- +id: comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CommentDtoAuthor', 'CommentDtoAuthor'] +slug: /tools/sdk/python/v3/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'CommentDtoAuthor'] +--- + +# CommentDtoAuthor + +Author of the comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional] +**id** | **str** | The unique ID of the object | [optional] +**name** | **str** | The display name of the object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.comment_dto_author import CommentDtoAuthor + +comment_dto_author = CommentDtoAuthor( +type='IDENTITY', +id='2c9180847e25f377017e2ae8cae4650b', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CompletedApproval.md b/docs/tools/sdk/python/Reference/V3/Models/CompletedApproval.md new file mode 100644 index 000000000..b5da62079 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CompletedApproval.md @@ -0,0 +1,143 @@ +--- +id: completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApproval', 'CompletedApproval'] +slug: /tools/sdk/python/v3/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'CompletedApproval'] +--- + +# CompletedApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval id. | [optional] +**name** | **str** | The name of the approval. | [optional] +**created** | **datetime** | When the approval was created. | [optional] +**modified** | **datetime** | When the approval was modified last time. | [optional] +**request_created** | **datetime** | When the access-request was created. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**reviewed_by** | [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**requested_object** | [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**requester_comment** | [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**reviewer_comment** | [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**previous_reviewers_comments** | [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**comment_required_when_rejected** | **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to False] +**state** | [**CompletedApprovalState**](completed-approval-state) | | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**remove_date_update_requested** | **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to False] +**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**sod_violation_context** | [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**pre_approval_trigger_result** | [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs provided during the request. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.completed_approval import CompletedApproval + +completed_approval = CompletedApproval( +id='id12345', +name='aName', +created='2017-07-11T18:45:37.098Z', +modified='2018-07-25T20:22:28.104Z', +request_created='2017-07-11T18:45:35.098Z', +request_type='GRANT_ACCESS', +requester=sailpoint.v3.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v3.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +reviewed_by=sailpoint.v3.models.access_item_reviewed_by.AccessItemReviewedBy( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +owner=sailpoint.v3.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +requested_object=sailpoint.v3.models.requestable_object_reference.RequestableObjectReference( + id = '2c9180835d2e5168015d32f890ca1581', + name = 'Applied Research Access', + description = 'Access to research information, lab results, and schematics', + type = 'ROLE', ), +requester_comment=, +reviewer_comment=, +previous_reviewers_comments=[ + sailpoint.v3.models.comment_dto.CommentDto( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ) + ], +forward_history=[ + sailpoint.v3.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], +comment_required_when_rejected=True, +state='APPROVED', +remove_date='2020-07-11T00:00Z', +remove_date_update_requested=True, +current_remove_date='2020-07-11T00:00Z', +sod_violation_context=sailpoint.v3.models.sod_violation_context_check_completed.SodViolationContextCheckCompleted( + state = 'SUCCESS', + uuid = 'f73d16e9-a038-46c5-b217-1246e15fdbdd', + violation_check_result = sailpoint.v3.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v3.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ), ), +pre_approval_trigger_result=sailpoint.v3.models.completed_approval_pre_approval_trigger_result.CompletedApproval_preApprovalTriggerResult( + comment = 'This request was autoapproved by our automated ETS subscriber', + decision = 'APPROVED', + reviewer = 'Automated AR Approval', + date = '2022-06-07T19:18:40.748Z', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..02b079381 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,40 @@ +--- +id: completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/python/v3/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'CompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | The comment from the trigger | [optional] +**decision** | [**CompletedApprovalState**](completed-approval-state) | | [optional] +**reviewer** | **str** | The name of the approver | [optional] +**var_date** | **datetime** | The date and time the trigger decided on the request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.completed_approval_pre_approval_trigger_result import CompletedApprovalPreApprovalTriggerResult + +completed_approval_pre_approval_trigger_result = CompletedApprovalPreApprovalTriggerResult( +comment='This request was autoapproved by our automated ETS subscriber', +decision='APPROVED', +reviewer='Automated AR Approval', +var_date='2022-06-07T19:18:40.748Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..81b9e82ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,40 @@ +--- +id: completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalRequesterComment', 'CompletedApprovalRequesterComment'] +slug: /tools/sdk/python/v3/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'CompletedApprovalRequesterComment'] +--- + +# CompletedApprovalRequesterComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.completed_approval_requester_comment import CompletedApprovalRequesterComment + +completed_approval_requester_comment = CompletedApprovalRequesterComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..9829ef88b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,40 @@ +--- +id: completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalReviewerComment', 'CompletedApprovalReviewerComment'] +slug: /tools/sdk/python/v3/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'CompletedApprovalReviewerComment'] +--- + +# CompletedApprovalReviewerComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.completed_approval_reviewer_comment import CompletedApprovalReviewerComment + +completed_approval_reviewer_comment = CompletedApprovalReviewerComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalState.md b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalState.md new file mode 100644 index 000000000..b37e53b10 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CompletedApprovalState.md @@ -0,0 +1,23 @@ +--- +id: completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletedApprovalState', 'CompletedApprovalState'] +slug: /tools/sdk/python/v3/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'CompletedApprovalState'] +--- + +# CompletedApprovalState + +Enum represents completed approval object's state. + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CompletionStatus.md b/docs/tools/sdk/python/Reference/V3/Models/CompletionStatus.md new file mode 100644 index 000000000..4c3d32ff3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CompletionStatus.md @@ -0,0 +1,27 @@ +--- +id: completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CompletionStatus', 'CompletionStatus'] +slug: /tools/sdk/python/v3/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'CompletionStatus'] +--- + +# CompletionStatus + +The status after completion. + +## Enum + +* `SUCCESS` (value: `'SUCCESS'`) + +* `FAILURE` (value: `'FAILURE'`) + +* `INCOMPLETE` (value: `'INCOMPLETE'`) + +* `PENDING` (value: `'PENDING'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..e567df326 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConflictingAccessCriteria', 'ConflictingAccessCriteria'] +slug: /tools/sdk/python/v3/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'ConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +**right_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.conflicting_access_criteria import ConflictingAccessCriteria + +conflicting_access_criteria = ConflictingAccessCriteria( +left_criteria=sailpoint.v3.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.v3.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ConnectorDetail.md b/docs/tools/sdk/python/Reference/V3/Models/ConnectorDetail.md new file mode 100644 index 000000000..9a3c89530 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ConnectorDetail.md @@ -0,0 +1,114 @@ +--- +id: connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorDetail', 'ConnectorDetail'] +slug: /tools/sdk/python/v3/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'ConnectorDetail'] +--- + +# ConnectorDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The connector name | [optional] +**type** | **str** | The connector type | [optional] +**class_name** | **str** | The connector class name | [optional] +**script_name** | **str** | The connector script name | [optional] +**application_xml** | **str** | The connector application xml | [optional] +**correlation_config_xml** | **str** | The connector correlation config xml | [optional] +**source_config_xml** | **str** | The connector source config xml | [optional] +**source_config** | **str** | The connector source config | [optional] +**source_config_from** | **str** | The connector source config origin | [optional] +**s3_location** | **str** | storage path key for this connector | [optional] +**uploaded_files** | **[]str** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**file_upload** | **bool** | true if the source is file upload | [optional] [default to False] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to False] +**translation_properties** | **map[string]object** | A map containing translation attributes by loacale key | [optional] +**connector_metadata** | **map[string]object** | A map containing metadata pertinent to the UI to be used | [optional] +**status** | **Enum** [ 'DEPRECATED', 'DEVELOPMENT', 'DEMO', 'RELEASED' ] | The connector status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.connector_detail import ConnectorDetail + +connector_detail = ConnectorDetail( +name='name', +type='ServiceNow', +class_name='class name', +script_name='servicenow', +application_xml=' + + +', +correlation_config_xml=' + + + + + + + + + + + +', +source_config_xml='
+ + + + + + +
', +source_config='
+ + + + + + +
', +source_config_from='sp-connect', +s3_location='custom-connector/scriptname', +uploaded_files=[pod/org/connectorFiles/testconnector/test1.jar], +file_upload=True, +direct_connect=True, +translation_properties={de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. +# DO NOT EDIT. This file is generated by "sailpointTranslate" command. +menuLabel_ConnectionSettings=Verbindungseinstellungen +menuLabel_AggregationSettings=Aggregationseinstellungen +sectionLabel_AuthenticationSettings=Verbindungseinstellungen +sectionLabel_AggregationSettings=Aggregationseinstellungen +sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

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..365600f59 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CriteriaType.md @@ -0,0 +1,39 @@ +--- +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'`) + +[[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..e94fef5a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EventAttributes.md @@ -0,0 +1,40 @@ +--- +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] +} + +## 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' +) + +``` +[[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..f1ad74328 --- /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** | Additonal 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 = '', + message = '', ), +accounts=[ + null + ], +account_count=3, +apps=[ + null + ], +app_count=2, +access=[ + null + ], +access_count=5, +entitlement_count=10, +role_count=1, +access_profile_count=1, +owns=[ + sailpoint.v3.models.owns.Owns( + sources = [ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], + entitlements = [ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], + access_profiles = [ + + ], + roles = [ + + ], + apps = [ + + ], + governance_groups = [ + + ], + fallback_approver = False, ) + ], +owns_count=5, +tags=[TAG_1, TAG_2], +tags_count=56, +visible_segments=[All Employees], +visible_segment_count=1 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..f142eb549 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,36 @@ +--- +id: identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/python/v3/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'IdentityDocumentAllOfIdentityProfile'] +--- + +# IdentityDocumentAllOfIdentityProfile + +Identity's identity profile. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity profile's ID. | [optional] +**name** | **str** | Identity profile's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_document_all_of_identity_profile import IdentityDocumentAllOfIdentityProfile + +identity_document_all_of_identity_profile = IdentityDocumentAllOfIdentityProfile( +id='3bc8ad26b8664945866b31339d1ff7d2', +name='HR Employees' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..e1175f5ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,38 @@ +--- +id: identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocumentAllOfManager', 'IdentityDocumentAllOfManager'] +slug: /tools/sdk/python/v3/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'IdentityDocumentAllOfManager'] +--- + +# IdentityDocumentAllOfManager + +Identity's manager. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of identity's manager. | [optional] +**name** | **str** | Name of identity's manager. | [optional] +**display_name** | **str** | Display name of identity's manager. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_document_all_of_manager import IdentityDocumentAllOfManager + +identity_document_all_of_manager = IdentityDocumentAllOfManager( +id='2c9180867dfe694b017e208e27c05799', +name='Amanda.Ross', +display_name='Amanda.Ross' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..21981ce4b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,36 @@ +--- +id: identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocumentAllOfSource', 'IdentityDocumentAllOfSource'] +slug: /tools/sdk/python/v3/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'IdentityDocumentAllOfSource'] +--- + +# IdentityDocumentAllOfSource + +Identity's source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of identity's source. | [optional] +**name** | **str** | Display name of identity's source. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_document_all_of_source import IdentityDocumentAllOfSource + +identity_document_all_of_source = IdentityDocumentAllOfSource( +id='2c91808b6e9e6fb8016eec1a2b6f7b5f', +name='ODS-HR-Employees' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..8347d68bc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityExceptionReportReference.md @@ -0,0 +1,35 @@ +--- +id: identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityExceptionReportReference', 'IdentityExceptionReportReference'] +slug: /tools/sdk/python/v3/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'IdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_result_id** | **str** | Task result ID. | [optional] +**report_name** | **str** | Report name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_exception_report_reference import IdentityExceptionReportReference + +identity_exception_report_reference = IdentityExceptionReportReference( +task_result_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +report_name='My annual report' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewRequest.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..68cdfd12c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewRequest.md @@ -0,0 +1,43 @@ +--- +id: identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewRequest', 'IdentityPreviewRequest'] +slug: /tools/sdk/python/v3/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'IdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The Identity id | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_preview_request import IdentityPreviewRequest + +identity_preview_request = IdentityPreviewRequest( +identity_id='', +identity_attribute_config=sailpoint.v3.models.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/IdentityPreviewResponse.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..2b8f3f995 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewResponse.md @@ -0,0 +1,49 @@ +--- +id: identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewResponse', 'IdentityPreviewResponse'] +slug: /tools/sdk/python/v3/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'IdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**preview_attributes** | [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_preview_response import IdentityPreviewResponse + +identity_preview_response = IdentityPreviewResponse( +identity=sailpoint.v3.models.identity_preview_response_identity.IdentityPreviewResponse_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +preview_attributes=[ + sailpoint.v3.models.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/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..81cbd921d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,38 @@ +--- +id: identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityPreviewResponseIdentity', 'IdentityPreviewResponseIdentity'] +slug: /tools/sdk/python/v3/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'IdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +Identity's basic details. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Identity's DTO type. | [optional] +**id** | **str** | Identity ID. | [optional] +**name** | **str** | Identity's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_preview_response_identity import IdentityPreviewResponseIdentity + +identity_preview_response_identity = IdentityPreviewResponseIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfile.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfile.md new file mode 100644 index 000000000..449afe449 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfile.md @@ -0,0 +1,73 @@ +--- +id: identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfile', 'IdentityProfile'] +slug: /tools/sdk/python/v3/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'IdentityProfile'] +--- + +# IdentityProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**description** | **str** | Identity profile's description. | [optional] +**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**priority** | **int** | Identity profile's priority. | [optional] +**authoritative_source** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] +**identity_refresh_required** | **bool** | 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. | [optional] [default to False] +**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional] +**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**identity_exception_report_reference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.identity_profile import IdentityProfile + +identity_profile = IdentityProfile( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +description='My custom flat file profile', +owner=sailpoint.v3.models.identity_profile_all_of_owner.IdentityProfile_allOf_owner( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +priority=10, +authoritative_source=sailpoint.v3.models.identity_profile_all_of_authoritative_source.IdentityProfile_allOf_authoritativeSource( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +identity_refresh_required=True, +identity_count=8, +identity_attribute_config=sailpoint.v3.models.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}, ), ) + ], ), +identity_exception_report_reference=sailpoint.v3.models.identity_exception_report_reference.IdentityExceptionReportReference( + task_result_id = '2b838de9-db9b-abcf-e646-d4f274ad4238', + report_name = 'My annual report', ), +has_time_based_attr=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..38d70c560 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,37 @@ +--- +id: identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/python/v3/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'IdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional] +**id** | **str** | Authoritative source's ID. | [optional] +**name** | **str** | Authoritative source's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_profile_all_of_authoritative_source import IdentityProfileAllOfAuthoritativeSource + +identity_profile_all_of_authoritative_source = IdentityProfileAllOfAuthoritativeSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..4e31bdf8c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,38 @@ +--- +id: identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileAllOfOwner', 'IdentityProfileAllOfOwner'] +slug: /tools/sdk/python/v3/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'IdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +Identity profile's owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's object type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_profile_all_of_owner import IdentityProfileAllOfOwner + +identity_profile_all_of_owner = IdentityProfileAllOfOwner( +type='IDENTITY', +id='2c9180835d191a86015d28455b4b232a', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..c74cb3552 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileExportedObject.md @@ -0,0 +1,41 @@ +--- +id: identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileExportedObject', 'IdentityProfileExportedObject'] +slug: /tools/sdk/python/v3/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'IdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +Identity profile exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **int** | Version or object from the target service. | [optional] +**var_self** | [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**object** | [**IdentityProfile**](identity-profile) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject + +identity_profile_exported_object = IdentityProfileExportedObject( +version=1, +var_self=sailpoint.v3.models.identity_profile_exported_object_self.IdentityProfileExportedObject_self( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ), +object= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..aa8a4036d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,38 @@ +--- +id: identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileExportedObjectSelf', 'IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/python/v3/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'IdentityProfileExportedObjectSelf'] +--- + +# IdentityProfileExportedObjectSelf + +Self block for exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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' ] | Exported object's DTO type. | [optional] +**id** | **str** | Exported object's ID. | [optional] +**name** | **str** | Exported object's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_profile_exported_object_self import IdentityProfileExportedObjectSelf + +identity_profile_exported_object_self = IdentityProfileExportedObjectSelf( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..34d2c6996 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,34 @@ +--- +id: identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/python/v3/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'IdentityProfileIdentityErrorReportArguments'] +--- + +# IdentityProfileIdentityErrorReportArguments + +Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authoritative_source** | **str** | Source ID. | [required] +} + +## Example + +```python +from sailpoint.v3.models.identity_profile_identity_error_report_arguments import IdentityProfileIdentityErrorReportArguments + +identity_profile_identity_error_report_arguments = IdentityProfileIdentityErrorReportArguments( +authoritative_source='1234sourceId5678902' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityProfilesConnections.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfilesConnections.md new file mode 100644 index 000000000..ca7f4fca7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityProfilesConnections.md @@ -0,0 +1,37 @@ +--- +id: identity-profiles-connections +title: IdentityProfilesConnections +pagination_label: IdentityProfilesConnections +sidebar_label: IdentityProfilesConnections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityProfilesConnections', 'IdentityProfilesConnections'] +slug: /tools/sdk/python/v3/models/identity-profiles-connections +tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'IdentityProfilesConnections'] +--- + +# IdentityProfilesConnections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the IdentityProfile this reference applies | [optional] +**name** | **str** | Human-readable display name of the IdentityProfile to which this reference applies | [optional] +**identity_count** | **int** | The Number of Identities managed by this IdentityProfile | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_profiles_connections import IdentityProfilesConnections + +identity_profiles_connections = IdentityProfilesConnections( +id='76cfddb62818416f816bc494410f46c4', +name='ODS-Identity-Profile', +identity_count=100 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityReference.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityReference.md new file mode 100644 index 000000000..6a3623727 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityReference.md @@ -0,0 +1,38 @@ +--- +id: identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReference', 'IdentityReference'] +slug: /tools/sdk/python/v3/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'IdentityReference'] +--- + +# IdentityReference + +The manager for the identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_reference import IdentityReference + +identity_reference = IdentityReference( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..0fd7ebc0d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,39 @@ +--- +id: identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityReferenceWithNameAndEmail', 'IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/python/v3/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'IdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type can only be IDENTITY. This is read-only. | [optional] +**id** | **str** | Identity ID. | [optional] +**name** | **str** | Identity's human-readable display name. This is read-only. | [optional] +**email** | **str** | Identity's email address. This is read-only. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail + +identity_reference_with_name_and_email = IdentityReferenceWithNameAndEmail( +type='IDENTITY', +id='5168015d32f890ca15812c9180835d2e', +name='Alison Ferguso', +email='alison.ferguso@identitysoon.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentitySummary.md b/docs/tools/sdk/python/Reference/V3/Models/IdentitySummary.md new file mode 100644 index 000000000..c0eac89b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentitySummary.md @@ -0,0 +1,39 @@ +--- +id: identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitySummary', 'IdentitySummary'] +slug: /tools/sdk/python/v3/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'IdentitySummary'] +--- + +# IdentitySummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of this identity summary | [optional] +**name** | **str** | Human-readable display name of identity | [optional] +**identity_id** | **str** | ID of the identity that this summary represents | [optional] +**completed** | **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.identity_summary import IdentitySummary + +identity_summary = IdentitySummary( +id='ff80818155fe8c080155fe8d925b0316', +name='SailPoint Services', +identity_id='c15b9f5cca5a4e9599eaa0e64fa921bd', +completed=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..347db8402 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md @@ -0,0 +1,36 @@ +--- +id: identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess', 'IdentityWithNewAccess'] +slug: /tools/sdk/python/v3/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'IdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +An identity with a set of access to be added + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity id to be checked. | [required] +**access_refs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] +} + +## Example + +```python +from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + +identity_with_new_access = IdentityWithNewAccess( +identity_id='2c91808568c529c60168cca6f90c1313', +access_refs=[{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}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..57bdcb125 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md @@ -0,0 +1,40 @@ +--- +id: identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] +slug: /tools/sdk/python/v3/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] +--- + +# IdentityWithNewAccess1 + +An identity with a set of access to be added + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Set of identity IDs to be checked. | [required] +**access_refs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] +**client_metadata** | **map[string]str** | 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.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + +identity_with_new_access1 = IdentityWithNewAccess1( +identity_id='2c91809050db617d0150e0bf3215385e', +access_refs=[ + null + ], +client_metadata={clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..cf46edec2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,38 @@ +--- +id: identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/python/v3/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'IdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +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.identity_with_new_access_access_refs_inner import IdentityWithNewAccessAccessRefsInner + +identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( +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/IdpDetails.md b/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md new file mode 100644 index 000000000..818249bce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md @@ -0,0 +1,62 @@ +--- +id: idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdpDetails', 'IdpDetails'] +slug: /tools/sdk/python/v3/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] +--- + +# IdpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP' ] | 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] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**auth_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_auth_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.idp_details import IdpDetails + +idp_details = IdpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +auth_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_auth_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v3.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..260d7ed41 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/python/v3/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'ImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | | [required] +} + +## Example + +```python +from sailpoint.v3.models.import_non_employee_records_in_bulk_request import ImportNonEmployeeRecordsInBulkRequest + +import_non_employee_records_in_bulk_request = ImportNonEmployeeRecordsInBulkRequest( +data=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ImportObject.md b/docs/tools/sdk/python/Reference/V3/Models/ImportObject.md new file mode 100644 index 000000000..7f1f04bce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ImportObject.md @@ -0,0 +1,38 @@ +--- +id: import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ImportObject', 'ImportObject'] +slug: /tools/sdk/python/v3/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'ImportObject'] +--- + +# ImportObject + +Object created or updated by import. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_RULE', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional] +**id** | **str** | ID of object created or updated by import. | [optional] +**name** | **str** | Display name of object created or updated by import. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.import_object import ImportObject + +import_object = ImportObject( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Index.md b/docs/tools/sdk/python/Reference/V3/Models/Index.md new file mode 100644 index 000000000..acc4155bc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['python', 'Python', 'sdk', 'models'] +slug: /tools/sdk/python/v3/models +tags: ['SDK', 'Software Development Kit', 'v3', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/python/Reference/V3/Models/Indices.md b/docs/tools/sdk/python/Reference/V3/Models/Indices.md new file mode 100644 index 000000000..fc5b4be9f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Indices.md @@ -0,0 +1,33 @@ +--- +id: index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Index', 'Index'] +slug: /tools/sdk/python/v3/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'Index'] +--- + +# Index + +Enum representing the currently supported indices. Additional values may be added in the future without notice. + +## Enum + +* `ACCESSPROFILES` (value: `'accessprofiles'`) + +* `ACCOUNTACTIVITIES` (value: `'accountactivities'`) + +* `ENTITLEMENTS` (value: `'entitlements'`) + +* `EVENTS` (value: `'events'`) + +* `IDENTITIES` (value: `'identities'`) + +* `ROLES` (value: `'roles'`) + +* `STAR` (value: `'*'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/InnerHit.md b/docs/tools/sdk/python/Reference/V3/Models/InnerHit.md new file mode 100644 index 000000000..2d423394c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/InnerHit.md @@ -0,0 +1,36 @@ +--- +id: inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'InnerHit', 'InnerHit'] +slug: /tools/sdk/python/v3/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'InnerHit'] +--- + +# InnerHit + +Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | 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. | [required] +**type** | **str** | 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. | [required] +} + +## Example + +```python +from sailpoint.v3.models.inner_hit import InnerHit + +inner_hit = InnerHit( +query='source.name:\"Active Directory\"', +type='access' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/JITConfiguration.md b/docs/tools/sdk/python/Reference/V3/Models/JITConfiguration.md new file mode 100644 index 000000000..8db029d7a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/JITConfiguration.md @@ -0,0 +1,37 @@ +--- +id: jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JITConfiguration', 'JITConfiguration'] +slug: /tools/sdk/python/v3/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'JITConfiguration'] +--- + +# JITConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to False] +**source_id** | **str** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**source_attribute_mappings** | **map[string]str** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] +} + +## Example + +```python +from sailpoint.v3.models.jit_configuration import JITConfiguration + +jit_configuration = JITConfiguration( +enabled=False, +source_id='2c9180857377ed2901739c12a2da5ac8', +source_attribute_mappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/JsonPatchOperation.md b/docs/tools/sdk/python/Reference/V3/Models/JsonPatchOperation.md new file mode 100644 index 000000000..a6e1b9692 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/JsonPatchOperation.md @@ -0,0 +1,38 @@ +--- +id: json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperation', 'JsonPatchOperation'] +slug: /tools/sdk/python/v3/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'JsonPatchOperation'] +--- + +# JsonPatchOperation + +A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy', 'test' ] | The operation to be performed | [required] +**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + +json_patch_operation = JsonPatchOperation( +op='replace', +path='/description', +value=New description +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/JsonPatchOperationValue.md b/docs/tools/sdk/python/Reference/V3/Models/JsonPatchOperationValue.md new file mode 100644 index 000000000..be7c06ebb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/JsonPatchOperationValue.md @@ -0,0 +1,32 @@ +--- +id: json-patch-operation-value +title: JsonPatchOperationValue +pagination_label: JsonPatchOperationValue +sidebar_label: JsonPatchOperationValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JsonPatchOperationValue', 'JsonPatchOperationValue'] +slug: /tools/sdk/python/v3/models/json-patch-operation-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'JsonPatchOperationValue'] +--- + +# JsonPatchOperationValue + +The value to be used for the operation, required for \"add\" and \"replace\" operations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v3.models.json_patch_operation_value import JsonPatchOperationValue + +json_patch_operation_value = JsonPatchOperationValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/python/Reference/V3/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..c3b878f3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/KbaAnswerRequestItem.md @@ -0,0 +1,35 @@ +--- +id: kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAnswerRequestItem', 'KbaAnswerRequestItem'] +slug: /tools/sdk/python/v3/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'KbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Question Id | [required] +**answer** | **str** | An answer for the KBA question | [required] +} + +## Example + +```python +from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem + +kba_answer_request_item = KbaAnswerRequestItem( +id='c54fee53-2d63-4fc5-9259-3e93b9994135', +answer='Your answer' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/python/Reference/V3/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..303ed9286 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/KbaAnswerResponseItem.md @@ -0,0 +1,37 @@ +--- +id: kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAnswerResponseItem', 'KbaAnswerResponseItem'] +slug: /tools/sdk/python/v3/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'KbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Question Id | [required] +**question** | **str** | Question description | [required] +**has_answer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | [required] +} + +## Example + +```python +from sailpoint.v3.models.kba_answer_response_item import KbaAnswerResponseItem + +kba_answer_response_item = KbaAnswerResponseItem( +id='c54fee53-2d63-4fc5-9259-3e93b9994135', +question='[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]', +has_answer=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/KbaAuthResponse.md b/docs/tools/sdk/python/Reference/V3/Models/KbaAuthResponse.md new file mode 100644 index 000000000..7fa24a9bb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/KbaAuthResponse.md @@ -0,0 +1,35 @@ +--- +id: kba-auth-response +title: KbaAuthResponse +pagination_label: KbaAuthResponse +sidebar_label: KbaAuthResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAuthResponse', 'KbaAuthResponse'] +slug: /tools/sdk/python/v3/models/kba-auth-response +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse', 'KbaAuthResponse'] +--- + +# KbaAuthResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kba_auth_response_items** | [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] +**status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED', 'LOCKOUT', 'NOT_ENOUGH_DATA' ] | MFA Authentication status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.kba_auth_response import KbaAuthResponse + +kba_auth_response = KbaAuthResponse( +kba_auth_response_items=[{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}], +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/KbaAuthResponseItem.md b/docs/tools/sdk/python/Reference/V3/Models/KbaAuthResponseItem.md new file mode 100644 index 000000000..483e6584f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/KbaAuthResponseItem.md @@ -0,0 +1,35 @@ +--- +id: kba-auth-response-item +title: KbaAuthResponseItem +pagination_label: KbaAuthResponseItem +sidebar_label: KbaAuthResponseItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaAuthResponseItem', 'KbaAuthResponseItem'] +slug: /tools/sdk/python/v3/models/kba-auth-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem', 'KbaAuthResponseItem'] +--- + +# KbaAuthResponseItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question_id** | **str** | The KBA question id | [optional] +**is_verified** | **bool** | Return true if verified | [optional] +} + +## Example + +```python +from sailpoint.v3.models.kba_auth_response_item import KbaAuthResponseItem + +kba_auth_response_item = KbaAuthResponseItem( +question_id='089899f13a8f4da7824996191587bab9', +is_verified=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/KbaQuestion.md b/docs/tools/sdk/python/Reference/V3/Models/KbaQuestion.md new file mode 100644 index 000000000..198b292e0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/KbaQuestion.md @@ -0,0 +1,40 @@ +--- +id: kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'KbaQuestion', 'KbaQuestion'] +slug: /tools/sdk/python/v3/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'KbaQuestion'] +--- + +# KbaQuestion + +KBA Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | KBA Question Id | [required] +**text** | **str** | KBA Question description | [required] +**has_answer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] +**num_answers** | **int** | Denotes the number of KBA configurations for this question | [required] +} + +## Example + +```python +from sailpoint.v3.models.kba_question import KbaQuestion + +kba_question = KbaQuestion( +id='143cfd3b-c23f-426b-ae5f-d3db06fa5919', +text='[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]', +has_answer=True, +num_answers=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/LifecycleState.md b/docs/tools/sdk/python/Reference/V3/Models/LifecycleState.md new file mode 100644 index 000000000..9d6dedcdd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/LifecycleState.md @@ -0,0 +1,63 @@ +--- +id: lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecycleState', 'LifecycleState'] +slug: /tools/sdk/python/v3/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'LifecycleState'] +--- + +# LifecycleState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**enabled** | **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to False] +**technical_name** | **str** | The lifecycle state's technical name. This is for internal use. | [required] +**description** | **str** | Lifecycle state's description. | [optional] +**identity_count** | **int** | Number of identities that have the lifecycle state. | [optional] [readonly] +**email_notification_option** | [**EmailNotificationOption**](email-notification-option) | | [optional] +**account_actions** | [**[]AccountAction**](account-action) | | [optional] +**access_profile_ids** | **[]str** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional] +**identity_state** | **str** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.lifecycle_state import LifecycleState + +lifecycle_state = LifecycleState( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +enabled=True, +technical_name='Technical Name', +description='Lifecycle description', +identity_count=42, +email_notification_option=sailpoint.v3.models.email_notification_option.EmailNotificationOption( + notify_managers = True, + notify_all_admins = True, + notify_specific_users = True, + email_address_list = [test@test.com, test2@test.com], ), +account_actions=[ + sailpoint.v3.models.account_action.AccountAction( + action = 'ENABLE', + source_ids = [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], ) + ], +access_profile_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], +identity_state='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/LifecyclestateDeleted.md b/docs/tools/sdk/python/Reference/V3/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..1bc8b1770 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/LifecyclestateDeleted.md @@ -0,0 +1,38 @@ +--- +id: lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LifecyclestateDeleted', 'LifecyclestateDeleted'] +slug: /tools/sdk/python/v3/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'LifecyclestateDeleted'] +--- + +# LifecyclestateDeleted + +Deleted lifecycle state. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIFECYCLE_STATE' ] | Deleted lifecycle state's DTO type. | [optional] +**id** | **str** | Deleted lifecycle state ID. | [optional] +**name** | **str** | Deleted lifecycle state's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.lifecyclestate_deleted import LifecyclestateDeleted + +lifecyclestate_deleted = LifecyclestateDeleted( +type='LIFECYCLE_STATE', +id='12345', +name='Contractor Lifecycle' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/python/Reference/V3/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..2b48fc0b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ListAccessProfiles401Response.md @@ -0,0 +1,33 @@ +--- +id: list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListAccessProfiles401Response', 'ListAccessProfiles401Response'] +slug: /tools/sdk/python/v3/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'ListAccessProfiles401Response'] +--- + +# ListAccessProfiles401Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.v3.models.list_access_profiles401_response import ListAccessProfiles401Response + +list_access_profiles401_response = ListAccessProfiles401Response( +error=JWT validation failed: JWT is expired +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/python/Reference/V3/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..67adec38b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ListAccessProfiles429Response.md @@ -0,0 +1,33 @@ +--- +id: list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListAccessProfiles429Response', 'ListAccessProfiles429Response'] +slug: /tools/sdk/python/v3/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'ListAccessProfiles429Response'] +--- + +# ListAccessProfiles429Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **object** | A message describing the error | [optional] +} + +## Example + +```python +from sailpoint.v3.models.list_access_profiles429_response import ListAccessProfiles429Response + +list_access_profiles429_response = ListAccessProfiles429Response( +message= Rate Limit Exceeded +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/python/Reference/V3/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..ff8c18bc1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ListCampaignFilters200Response.md @@ -0,0 +1,44 @@ +--- +id: list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListCampaignFilters200Response', 'ListCampaignFilters200Response'] +slug: /tools/sdk/python/v3/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'ListCampaignFilters200Response'] +--- + +# ListCampaignFilters200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**count** | **int** | Number of filters returned. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.list_campaign_filters200_response import ListCampaignFilters200Response + +list_campaign_filters200_response = ListCampaignFilters200Response( +items=[ + sailpoint.v3.models.campaign_filter_details.CampaignFilterDetails( + id = '5ec18cef39020d6fd7a60ad3970aba61', + name = 'Identity Attribute Campaign Filter', + description = 'Campaign filter to certify data based on an identity attribute's specified property.', + owner = 'SailPoint Support', + mode = INCLUSION, + criteria_list = [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}], + is_system_filter = False, ) + ], +count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/python/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..105d47374 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,57 @@ +--- +id: list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/python/v3/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'ListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Operator ID. | [optional] +**name** | **str** | Operator friendly name | [optional] +**type** | **str** | Operator type | [optional] +**description** | **str** | Description of the operator | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**example_output** | [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**version_number** | **int** | Version number | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**output_schema** | **object** | Example output schema | [optional] +**input_example** | **object** | Example trigger payload if applicable | [optional] +} + +## Example + +```python +from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + +list_complete_workflow_library200_response_inner = ListCompleteWorkflowLibrary200ResponseInner( +id='sp:compare-boolean', +name='Compare Boolean Values', +type='OPERATOR', +description='Compare two boolean values and decide what happens based on the result.', +form_fields=[{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}], +example_output=, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +version_number=56, +is_simulation_enabled=True, +is_dynamic_schema=False, +output_schema=sailpoint.v3.models.output_schema.outputSchema(), +input_example={changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/LocaleOrigin.md b/docs/tools/sdk/python/Reference/V3/Models/LocaleOrigin.md new file mode 100644 index 000000000..142cb64c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/LocaleOrigin.md @@ -0,0 +1,23 @@ +--- +id: locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LocaleOrigin', 'LocaleOrigin'] +slug: /tools/sdk/python/v3/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'LocaleOrigin'] +--- + +# LocaleOrigin + +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. + +## Enum + +* `DEFAULT` (value: `'DEFAULT'`) + +* `REQUEST` (value: `'REQUEST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/LockoutConfiguration.md b/docs/tools/sdk/python/Reference/V3/Models/LockoutConfiguration.md new file mode 100644 index 000000000..0f870fee6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/LockoutConfiguration.md @@ -0,0 +1,37 @@ +--- +id: lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LockoutConfiguration', 'LockoutConfiguration'] +slug: /tools/sdk/python/v3/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'LockoutConfiguration'] +--- + +# LockoutConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maximum_attempts** | **int** | The maximum attempts allowed before lockout occurs. | [optional] +**lockout_duration** | **int** | The total time in minutes a user will be locked out. | [optional] +**lockout_window** | **int** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.lockout_configuration import LockoutConfiguration + +lockout_configuration = LockoutConfiguration( +maximum_attempts=5, +lockout_duration=15, +lockout_window=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClient.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClient.md new file mode 100644 index 000000000..37cf1df38 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClient.md @@ -0,0 +1,74 @@ +--- +id: managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClient', 'ManagedClient'] +slug: /tools/sdk/python/v3/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'ManagedClient'] +--- + +# ManagedClient + +Managed Client + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ManagedClient ID | [optional] [readonly] +**alert_key** | **str** | ManagedClient alert key | [optional] [readonly] +**api_gateway_base_url** | **str** | | [optional] +**cookbook** | **str** | | [optional] +**cc_id** | **int** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**client_id** | **str** | The client ID used in API management | [required] +**cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] +**description** | **str** | ManagedClient description | [required][default to ''] +**ip_address** | **str** | The public IP address of the ManagedClient | [optional] [readonly] +**last_seen** | **datetime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**name** | **str** | ManagedClient name | [optional] [default to 'VA-$clientId'] +**since_last_seen** | **str** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**status** | **Enum** [ 'NORMAL', 'UNDEFINED', 'NOT_CONFIGURED', 'CONFIGURING', 'WARNING', 'ERROR', 'FAILED' ] | Status of the ManagedClient | [optional] [readonly] +**type** | **str** | Type of the ManagedClient (VA, CCG) | [required] +**cluster_type** | **Enum** [ 'idn', 'iai', 'spConnectCluster', 'sqsCluster', 'das-rc', 'das-pc', 'das-dc' ] | Cluster Type of the ManagedClient | [optional] [readonly] +**va_download_url** | **str** | ManagedClient VA download URL | [optional] [readonly] +**va_version** | **str** | Version that the ManagedClient's VA is running | [optional] [readonly] +**secret** | **str** | Client's apiKey | [optional] +**created_at** | **datetime** | The date/time this ManagedClient was created | [optional] +**updated_at** | **datetime** | The date/time this ManagedClient was last updated | [optional] +**provision_status** | **Enum** [ 'PROVISIONED', 'DRAFT' ] | The provisioning status of the ManagedClient | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.managed_client import ManagedClient + +managed_client = ManagedClient( +id='2c9180878eaf4204018eb019c3570003', +alert_key='CLIENT_STATUS_NOT_CONFIGURED', +api_gateway_base_url='', +cookbook='', +cc_id=2248, +client_id='00be54a2-bb6d-402f-9159-beb2d5319347', +cluster_id='e1ff7bb24c934240bbf55e1aa39e41c5', +description='', +ip_address='123.456.78.90', +last_seen='2020-01-01T00:00Z', +name='VA-$clientId', +since_last_seen='15000', +status='NORMAL', +type='VA', +cluster_type='idn', +va_download_url='aUrl', +va_version='va-megapod-useast1-610-1621372012', +secret='ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381', +created_at='2023-08-04T20:48:01.865Z', +updated_at='2023-08-04T20:48:01.865Z', +provision_status='PROVISIONED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClientRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientRequest.md new file mode 100644 index 000000000..5351cebed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientRequest.md @@ -0,0 +1,40 @@ +--- +id: managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientRequest', 'ManagedClientRequest'] +slug: /tools/sdk/python/v3/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'ManagedClientRequest'] +--- + +# ManagedClientRequest + +Managed Client Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] +**description** | **str** | description for the ManagedClient to create | [optional] +**name** | **str** | name for the ManagedClient to create | [optional] +**type** | **str** | Type of the ManagedClient (VA, CCG) to create | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_client_request import ManagedClientRequest + +managed_client_request = ManagedClientRequest( +cluster_id='aClusterId', +description='A short description of the ManagedClient', +name='aName', +type='VA' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClientStatus.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientStatus.md new file mode 100644 index 000000000..7440b2334 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientStatus.md @@ -0,0 +1,40 @@ +--- +id: managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatus', 'ManagedClientStatus'] +slug: /tools/sdk/python/v3/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'ManagedClientStatus'] +--- + +# ManagedClientStatus + +Managed Client Status + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | **object** | ManagedClientStatus body information | [required] +**status** | [**ManagedClientStatusCode**](managed-client-status-code) | | [required] +**type** | [**ManagedClientType**](managed-client-type) | | [required] +**timestamp** | **datetime** | timestamp on the Client Status update | [required] +} + +## Example + +```python +from sailpoint.v3.models.managed_client_status import ManagedClientStatus + +managed_client_status = ManagedClientStatus( +body={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='NORMAL', +type='CCG', +timestamp='2020-01-01T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClientStatusCode.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..0d8018eb4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientStatusCode.md @@ -0,0 +1,33 @@ +--- +id: managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientStatusCode', 'ManagedClientStatusCode'] +slug: /tools/sdk/python/v3/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'ManagedClientStatusCode'] +--- + +# ManagedClientStatusCode + +Status of a Managed Client + +## Enum + +* `NORMAL` (value: `'NORMAL'`) + +* `UNDEFINED` (value: `'UNDEFINED'`) + +* `NOT_CONFIGURED` (value: `'NOT_CONFIGURED'`) + +* `CONFIGURING` (value: `'CONFIGURING'`) + +* `WARNING` (value: `'WARNING'`) + +* `ERROR` (value: `'ERROR'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClientType.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientType.md new file mode 100644 index 000000000..fecfc633f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClientType.md @@ -0,0 +1,27 @@ +--- +id: managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClientType', 'ManagedClientType'] +slug: /tools/sdk/python/v3/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'ManagedClientType'] +--- + +# ManagedClientType + +Managed Client type + +## Enum + +* `CCG` (value: `'CCG'`) + +* `VA` (value: `'VA'`) + +* `INTERNAL` (value: `'INTERNAL'`) + +* `IIQ_HARVESTER` (value: `'IIQ_HARVESTER'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md new file mode 100644 index 000000000..d6965d235 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md @@ -0,0 +1,96 @@ +--- +id: managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedCluster', 'ManagedCluster'] +slug: /tools/sdk/python/v3/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'ManagedCluster'] +--- + +# ManagedCluster + +Managed Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ManagedCluster ID | [required] +**name** | **str** | ManagedCluster name | [optional] +**pod** | **str** | ManagedCluster pod | [optional] +**org** | **str** | ManagedCluster org | [optional] +**type** | [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**configuration** | **map[string]str** | ManagedProcess configuration map | [optional] +**key_pair** | [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**attributes** | [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**description** | **str** | ManagedCluster description | [optional] [default to 'q'] +**redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**client_type** | [**ManagedClientType**](managed-client-type) | | [required] +**ccg_version** | **str** | CCG version used by the ManagedCluster | [required] +**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False] +**log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional] +**operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False] +**status** | **str** | Cluster status | [optional] +**public_key_certificate** | **str** | Public key certificate | [optional] +**public_key_thumbprint** | **str** | Public key thumbprint | [optional] +**public_key** | **str** | Public key | [optional] +**alert_key** | **str** | Key describing any immediate cluster alerts | [optional] +**client_ids** | **[]str** | List of clients in a cluster | [optional] +**service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0] +**cc_id** | **str** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to '0'] +**created_at** | **datetime** | The date/time this cluster was created | [optional] +**updated_at** | **datetime** | The date/time this cluster was last updated | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster import ManagedCluster + +managed_cluster = ManagedCluster( +id='e1ff7bb24c934240bbf55e1aa39e41c5', +name='Managed Cluster Name', +pod='megapod-useast1', +org='denali', +type='idn', +configuration={clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5}, +key_pair=sailpoint.v3.models.managed_cluster_key_pair.ManagedClusterKeyPair( + public_key = '-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----', + public_key_thumbprint = '6CMlaJIV44-xJxcB3CJBjDUUn54', + public_key_certificate = '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', ), +attributes=sailpoint.v3.models.managed_cluster_attributes.ManagedClusterAttributes( + queue = sailpoint.v3.models.managed_cluster_queue.ManagedClusterQueue( + name = 'megapod-useast1-denali-lwt-cluster-1533', + region = 'us-east-1', ), + keystore = '/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW', ), +description='q', +redis=sailpoint.v3.models.managed_cluster_redis.ManagedClusterRedis( + redis_host = 'megapod-useast1-shared-redis.cloud.sailpoint.com', + redis_port = 6379, ), +client_type='CCG', +ccg_version='v01', +pinned_config=False, +log_configuration=sailpoint.v3.models.client_log_configuration.ClientLogConfiguration( + client_id = '3a38a51992e8445ab51a549c0a70ee66', + duration_minutes = 120, + expiration = '2024-11-06T01:31:08.013164Z', + root_level = 'INFO', + log_levels = INFO, ), +operational=False, +status='NORMAL', +public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----', +public_key_thumbprint='obc6pLiulGbtZ', +public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----', +alert_key='LIMITED_RESOURCES', +client_ids=[1244, 1245], +service_count=6, +cc_id='0', +created_at='2023-08-04T20:48:01.865Z', +updated_at='2023-08-04T20:48:01.865Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..b97457260 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterAttributes.md @@ -0,0 +1,38 @@ +--- +id: managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterAttributes', 'ManagedClusterAttributes'] +slug: /tools/sdk/python/v3/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'ManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**queue** | [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**keystore** | **str** | ManagedCluster keystore for spConnectCluster type | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster_attributes import ManagedClusterAttributes + +managed_cluster_attributes = ManagedClusterAttributes( +queue=sailpoint.v3.models.managed_cluster_queue.ManagedClusterQueue( + name = 'megapod-useast1-denali-lwt-cluster-1533', + region = 'us-east-1', ), +keystore='/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..a000c5bc4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterKeyPair.md @@ -0,0 +1,38 @@ +--- +id: managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterKeyPair', 'ManagedClusterKeyPair'] +slug: /tools/sdk/python/v3/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'ManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +Managed Cluster key pair for Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**public_key** | **str** | ManagedCluster publicKey | [optional] +**public_key_thumbprint** | **str** | ManagedCluster publicKeyThumbprint | [optional] +**public_key_certificate** | **str** | ManagedCluster publicKeyCertificate | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster_key_pair import ManagedClusterKeyPair + +managed_cluster_key_pair = ManagedClusterKeyPair( +public_key='-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----', +public_key_thumbprint='6CMlaJIV44-xJxcB3CJBjDUUn54', +public_key_certificate='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterQueue.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..331fe1f61 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterQueue.md @@ -0,0 +1,36 @@ +--- +id: managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterQueue', 'ManagedClusterQueue'] +slug: /tools/sdk/python/v3/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'ManagedClusterQueue'] +--- + +# ManagedClusterQueue + +Managed Cluster key pair for Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | ManagedCluster queue name | [optional] +**region** | **str** | ManagedCluster queue aws region | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster_queue import ManagedClusterQueue + +managed_cluster_queue = ManagedClusterQueue( +name='megapod-useast1-denali-lwt-cluster-1533', +region='us-east-1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterRedis.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..33b13802d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterRedis.md @@ -0,0 +1,36 @@ +--- +id: managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterRedis', 'ManagedClusterRedis'] +slug: /tools/sdk/python/v3/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'ManagedClusterRedis'] +--- + +# ManagedClusterRedis + +Managed Cluster Redis Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**redis_host** | **str** | ManagedCluster redisHost | [optional] +**redis_port** | **int** | ManagedCluster redisPort | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster_redis import ManagedClusterRedis + +managed_cluster_redis = ManagedClusterRedis( +redis_host='megapod-useast1-shared-redis.cloud.sailpoint.com', +redis_port=6379 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..3312ed63d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterRequest.md @@ -0,0 +1,40 @@ +--- +id: managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterRequest', 'ManagedClusterRequest'] +slug: /tools/sdk/python/v3/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'ManagedClusterRequest'] +--- + +# ManagedClusterRequest + +Request to create Managed Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | ManagedCluster name | [required] +**type** | [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**configuration** | **map[string]str** | ManagedProcess configuration map | [optional] +**description** | **str** | ManagedCluster description | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + +managed_cluster_request = ManagedClusterRequest( +name='Managed Cluster Name', +type='idn', +configuration={clusterExternalId=externalId, ccgVersion=77.0.0}, +description='A short description of the managed cluster.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterTypes.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..9b7ec78a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterTypes.md @@ -0,0 +1,23 @@ +--- +id: managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterTypes', 'ManagedClusterTypes'] +slug: /tools/sdk/python/v3/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'ManagedClusterTypes'] +--- + +# ManagedClusterTypes + +The Type of Cluster + +## Enum + +* `IDN` (value: `'idn'`) + +* `IAI` (value: `'iai'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/python/Reference/V3/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..0e3feffbb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagerCorrelationMapping.md @@ -0,0 +1,35 @@ +--- +id: manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagerCorrelationMapping', 'ManagerCorrelationMapping'] +slug: /tools/sdk/python/v3/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'ManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_attribute_name** | **str** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**identity_attribute_name** | **str** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.manager_correlation_mapping import ManagerCorrelationMapping + +manager_correlation_mapping = ManagerCorrelationMapping( +account_attribute_name='manager', +identity_attribute_name='manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManualDiscoverApplications.md b/docs/tools/sdk/python/Reference/V3/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..a2f8b28e5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManualDiscoverApplications.md @@ -0,0 +1,35 @@ +--- +id: manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualDiscoverApplications', 'ManualDiscoverApplications'] +slug: /tools/sdk/python/v3/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'ManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] +} + +## Example + +```python +from sailpoint.v3.models.manual_discover_applications import ManualDiscoverApplications + +manual_discover_applications = ManualDiscoverApplications( +file='application_name,description +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App."' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/python/Reference/V3/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..1bdcc37a1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,35 @@ +--- +id: manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualDiscoverApplicationsTemplate', 'ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/python/v3/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'ManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_name** | **str** | Name of the application. | [optional] +**description** | **str** | Description of the application. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate + +manual_discover_applications_template = ManualDiscoverApplicationsTemplate( +application_name='Example Application', +description='Example Description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetails.md b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..b01d61279 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetails.md @@ -0,0 +1,57 @@ +--- +id: manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetails', 'ManualWorkItemDetails'] +slug: /tools/sdk/python/v3/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'ManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False] +**original_owner** | [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**current_owner** | [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**modified** | **datetime** | Time at which item was modified. | [optional] +**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.manual_work_item_details import ManualWorkItemDetails + +manual_work_item_details = ManualWorkItemDetails( +forwarded=True, +original_owner=sailpoint.v3.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +current_owner=sailpoint.v3.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), +modified='2019-08-23T18:52:57.398Z', +status='PENDING', +forward_history=[ + sailpoint.v3.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..e33d3d231 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,38 @@ +--- +id: manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/python/v3/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'ManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +Identity of current work item owner. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of current work item owner's identity. | [optional] +**id** | **str** | ID of current work item owner's identity. | [optional] +**name** | **str** | Display name of current work item owner. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.manual_work_item_details_current_owner import ManualWorkItemDetailsCurrentOwner + +manual_work_item_details_current_owner = ManualWorkItemDetailsCurrentOwner( +type='IDENTITY', +id='2c3780a46faadee4016fb4e018c20652', +name='Allen Albertson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..2dc632ed4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,38 @@ +--- +id: manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/python/v3/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'ManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +Identity of original work item owner, if the work item has been forwarded. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | DTO type of original work item owner's identity. | [optional] +**id** | **str** | ID of original work item owner's identity. | [optional] +**name** | **str** | Display name of original work item owner. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.manual_work_item_details_original_owner import ManualWorkItemDetailsOriginalOwner + +manual_work_item_details_original_owner = ManualWorkItemDetailsOriginalOwner( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemState.md b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemState.md new file mode 100644 index 000000000..45ce65a1f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManualWorkItemState.md @@ -0,0 +1,31 @@ +--- +id: manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManualWorkItemState', 'ManualWorkItemState'] +slug: /tools/sdk/python/v3/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'ManualWorkItemState'] +--- + +# ManualWorkItemState + +Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. + +## Enum + +* `PENDING` (value: `'PENDING'`) + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `EXPIRED` (value: `'EXPIRED'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +* `ARCHIVED` (value: `'ARCHIVED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/MetricAggregation.md b/docs/tools/sdk/python/Reference/V3/Models/MetricAggregation.md new file mode 100644 index 000000000..540204793 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/MetricAggregation.md @@ -0,0 +1,38 @@ +--- +id: metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MetricAggregation', 'MetricAggregation'] +slug: /tools/sdk/python/v3/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'MetricAggregation'] +--- + +# MetricAggregation + +The calculation done on the results of the query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | 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. | [required] +**type** | [**MetricType**](metric-type) | | [optional] [default to MetricType.UNIQUE_COUNT] +**var_field** | **str** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | [required] +} + +## Example + +```python +from sailpoint.v3.models.metric_aggregation import MetricAggregation + +metric_aggregation = MetricAggregation( +name='Access Name Count', +type='UNIQUE_COUNT', +var_field='@access.name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/MetricType.md b/docs/tools/sdk/python/Reference/V3/Models/MetricType.md new file mode 100644 index 000000000..d8fce608c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/MetricType.md @@ -0,0 +1,33 @@ +--- +id: metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MetricType', 'MetricType'] +slug: /tools/sdk/python/v3/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'MetricType'] +--- + +# MetricType + +Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. + +## Enum + +* `COUNT` (value: `'COUNT'`) + +* `UNIQUE_COUNT` (value: `'UNIQUE_COUNT'`) + +* `AVG` (value: `'AVG'`) + +* `SUM` (value: `'SUM'`) + +* `MEDIAN` (value: `'MEDIAN'`) + +* `MIN` (value: `'MIN'`) + +* `MAX` (value: `'MAX'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/MfaConfigTestResponse.md b/docs/tools/sdk/python/Reference/V3/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..572fb6db1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/MfaConfigTestResponse.md @@ -0,0 +1,36 @@ +--- +id: mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaConfigTestResponse', 'MfaConfigTestResponse'] +slug: /tools/sdk/python/v3/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'MfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +Response model for configuration test of a given MFA method + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'FAILED' ] | The configuration test result. | [optional] [readonly] +**error** | **str** | The error message to indicate the failure of configuration test. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.mfa_config_test_response import MfaConfigTestResponse + +mfa_config_test_response = MfaConfigTestResponse( +state='SUCCESS', +error='MFA Method is disabled.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/MfaDuoConfig.md b/docs/tools/sdk/python/Reference/V3/Models/MfaDuoConfig.md new file mode 100644 index 000000000..dca360e4b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/MfaDuoConfig.md @@ -0,0 +1,43 @@ +--- +id: mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaDuoConfig', 'MfaDuoConfig'] +slug: /tools/sdk/python/v3/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'MfaDuoConfig'] +--- + +# MfaDuoConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfa_method** | **str** | Mfa method name | [optional] +**enabled** | **bool** | If MFA method is enabled. | [optional] [default to False] +**host** | **str** | The server host name or IP address of the MFA provider. | [optional] +**access_key** | **str** | The secret key for authenticating requests to the MFA provider. | [optional] +**identity_attribute** | **str** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**config_properties** | **map[string]object** | A map with additional config properties for the given MFA method - duo-web. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig + +mfa_duo_config = MfaDuoConfig( +mfa_method='duo-web', +enabled=True, +host='example.com', +access_key='qw123Y3QlA5UqocYpdU3rEkzrK2D497y', +identity_attribute='email', +config_properties={skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/MfaOktaConfig.md b/docs/tools/sdk/python/Reference/V3/Models/MfaOktaConfig.md new file mode 100644 index 000000000..4a63ee4d1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/MfaOktaConfig.md @@ -0,0 +1,41 @@ +--- +id: mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MfaOktaConfig', 'MfaOktaConfig'] +slug: /tools/sdk/python/v3/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'MfaOktaConfig'] +--- + +# MfaOktaConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfa_method** | **str** | Mfa method name | [optional] +**enabled** | **bool** | If MFA method is enabled. | [optional] [default to False] +**host** | **str** | The server host name or IP address of the MFA provider. | [optional] +**access_key** | **str** | The secret key for authenticating requests to the MFA provider. | [optional] +**identity_attribute** | **str** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig + +mfa_okta_config = MfaOktaConfig( +mfa_method='okta-verify', +enabled=True, +host='example.com', +access_key='qw123Y3QlA5UqocYpdU3rEkzrK2D497y', +identity_attribute='email' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ModelSchema.md b/docs/tools/sdk/python/Reference/V3/Models/ModelSchema.md new file mode 100644 index 000000000..c4398ca01 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ModelSchema.md @@ -0,0 +1,55 @@ +--- +id: model-schema +title: ModelSchema +pagination_label: ModelSchema +sidebar_label: ModelSchema +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ModelSchema', 'ModelSchema'] +slug: /tools/sdk/python/v3/models/model-schema +tags: ['SDK', 'Software Development Kit', 'ModelSchema', 'ModelSchema'] +--- + +# ModelSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Schema. | [optional] +**name** | **str** | The name of the Schema. | [optional] +**native_object_type** | **str** | The name of the object type on the native system that the schema represents. | [optional] +**identity_attribute** | **str** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**display_attribute** | **str** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**hierarchy_attribute** | **str** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**configuration** | **object** | Holds any extra configuration data that the schema may require. | [optional] +**attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**created** | **datetime** | The date the Schema was created. | [optional] +**modified** | **datetime** | The date the Schema was last modified. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.model_schema import ModelSchema + +model_schema = ModelSchema( +id='2c9180835d191a86015d28455b4a2329', +name='account', +native_object_type='User', +identity_attribute='sAMAccountName', +display_attribute='distinguishedName', +hierarchy_attribute='memberOf', +include_permissions=False, +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +configuration={groupMemberAttribute=member}, +attributes=[{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}], +created='2019-12-24T22:32:58.104Z', +modified='2019-12-31T20:22:28.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/MultiPolicyRequest.md b/docs/tools/sdk/python/Reference/V3/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..2e646dde9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/MultiPolicyRequest.md @@ -0,0 +1,35 @@ +--- +id: multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'MultiPolicyRequest', 'MultiPolicyRequest'] +slug: /tools/sdk/python/v3/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'MultiPolicyRequest'] +--- + +# MultiPolicyRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filtered_policy_list** | **[]str** | Multi-policy report will be run for this list of ids | [optional] +} + +## Example + +```python +from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + +multi_policy_request = MultiPolicyRequest( +filtered_policy_list=[ + '[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NestedAggregation.md b/docs/tools/sdk/python/Reference/V3/Models/NestedAggregation.md new file mode 100644 index 000000000..1b6d1d97a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NestedAggregation.md @@ -0,0 +1,36 @@ +--- +id: nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NestedAggregation', 'NestedAggregation'] +slug: /tools/sdk/python/v3/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'NestedAggregation'] +--- + +# NestedAggregation + +The nested aggregation object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the nested aggregate to be included in the result. | [required] +**type** | **str** | The type of the nested object. | [required] +} + +## Example + +```python +from sailpoint.v3.models.nested_aggregation import NestedAggregation + +nested_aggregation = NestedAggregation( +name='id', +type='access' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NetworkConfiguration.md b/docs/tools/sdk/python/Reference/V3/Models/NetworkConfiguration.md new file mode 100644 index 000000000..966acdc89 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NetworkConfiguration.md @@ -0,0 +1,37 @@ +--- +id: network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NetworkConfiguration', 'NetworkConfiguration'] +slug: /tools/sdk/python/v3/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'NetworkConfiguration'] +--- + +# NetworkConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**range** | **[]str** | The collection of ip ranges. | [optional] +**geolocation** | **[]str** | The collection of country codes. | [optional] +**whitelisted** | **bool** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.network_configuration import NetworkConfiguration + +network_configuration = NetworkConfiguration( +range=[1.3.7.2, 255.255.255.252/30], +geolocation=[CA, FR, HT], +whitelisted=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..fe224ae88 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,33 @@ +--- +id: non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalDecision', 'NonEmployeeApprovalDecision'] +slug: /tools/sdk/python/v3/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'NonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment on the approval item. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_approval_decision import NonEmployeeApprovalDecision + +non_employee_approval_decision = NonEmployeeApprovalDecision( +comment='Approved by manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..7bfc29965 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,55 @@ +--- +id: non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItem', 'NonEmployeeApprovalItem'] +slug: /tools/sdk/python/v3/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'NonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_request** | [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem + +non_employee_approval_item = NonEmployeeApprovalItem( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='I approve', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_request=sailpoint.v3.models.non_employee_request_lite.NonEmployeeRequestLite( + id = 'ac110005-7156-1150-8171-5b292e3e0084', + requester = sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..c1078e0df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,49 @@ +--- +id: non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItemBase', 'NonEmployeeApprovalItemBase'] +slug: /tools/sdk/python/v3/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'NonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_approval_item_base import NonEmployeeApprovalItemBase + +non_employee_approval_item_base = NonEmployeeApprovalItemBase( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='I approve', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..e42cff6d8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,51 @@ +--- +id: non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalItemDetail', 'NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/python/v3/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'NonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee approval item id | [optional] +**approver** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**approval_order** | **float** | Approval order | [optional] +**comment** | **str** | comment of approver | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_request** | [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail + +non_employee_approval_item_detail = NonEmployeeApprovalItemDetail( +id='2c1e388b-1e55-4b0a-ab5c-897f1204159c', +approver=sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='test.account', +approval_status='APPROVED', +approval_order=1, +comment='I approve', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_request= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..3b1dbc57c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,37 @@ +--- +id: non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeApprovalSummary', 'NonEmployeeApprovalSummary'] +slug: /tools/sdk/python/v3/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'NonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **int** | The number of approved non-employee approval requests. | [optional] +**pending** | **int** | The number of pending non-employee approval requests. | [optional] +**rejected** | **int** | The number of rejected non-employee approval requests. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_approval_summary import NonEmployeeApprovalSummary + +non_employee_approval_summary = NonEmployeeApprovalSummary( +approved=2, +pending=2, +rejected=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..49ec8cfd5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,41 @@ +--- +id: non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeBulkUploadJob', 'NonEmployeeBulkUploadJob'] +slug: /tools/sdk/python/v3/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'NonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The bulk upload job's ID. (UUID) | [optional] +**source_id** | **str** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**created** | **datetime** | The date-time the job was submitted. | [optional] +**modified** | **datetime** | The date-time that the job was last updated. | [optional] +**status** | **Enum** [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'ERROR' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob + +non_employee_bulk_upload_job = NonEmployeeBulkUploadJob( +id='2c91808568c529c60168cca6f90cffff', +source_id='2c91808568c529c60168cca6f90c1313', +created='2019-08-23T18:52:59.162Z', +modified='2019-08-23T18:52:59.162Z', +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..fb7dc69dd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,33 @@ +--- +id: non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeBulkUploadStatus', 'NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/python/v3/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'NonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'ERROR' ] | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus + +non_employee_bulk_upload_status = NonEmployeeBulkUploadStatus( +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..81f16964f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,23 @@ +--- +id: non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdentityDtoType', 'NonEmployeeIdentityDtoType'] +slug: /tools/sdk/python/v3/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'NonEmployeeIdentityDtoType'] +--- + +# NonEmployeeIdentityDtoType + +Identifies if the identity is a normal identity or a governance group + +## Enum + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..86b750eef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,35 @@ +--- +id: non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/python/v3/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'NonEmployeeIdentityReferenceWithId'] +--- + +# NonEmployeeIdentityReferenceWithId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_identity_reference_with_id import NonEmployeeIdentityReferenceWithId + +non_employee_identity_reference_with_id = NonEmployeeIdentityReferenceWithId( +type='IDENTITY', +id='5168015d32f890ca15812c9180835d2e' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..1dbf8ef8f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,33 @@ +--- +id: non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeIdnUserRequest', 'NonEmployeeIdnUserRequest'] +slug: /tools/sdk/python/v3/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'NonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity id. | [required] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_idn_user_request import NonEmployeeIdnUserRequest + +non_employee_idn_user_request = NonEmployeeIdnUserRequest( +id='2c91808570313110017040b06f344ec9' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRecord.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..ed3d8e2cf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRecord.md @@ -0,0 +1,57 @@ +--- +id: non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRecord', 'NonEmployeeRecord'] +slug: /tools/sdk/python/v3/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'NonEmployeeRecord'] +--- + +# NonEmployeeRecord + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee record id. | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**source_id** | **str** | Non-Employee's source id. | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [optional] +**end_date** | **datetime** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_record import NonEmployeeRecord + +non_employee_record = NonEmployeeRecord( +id='ef38f94347e94562b5bb8424a56397d8', +account_name='Abby.Smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +source_id='2c91808568c529c60168cca6f90c1313', +data={description=Auditing}, +start_date='2019-08-23T18:52:59.162Z', +end_date='2020-08-23T18:52:59.162Z', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..635d21077 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,33 @@ +--- +id: non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRejectApprovalDecision', 'NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/python/v3/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'NonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment on the approval item. | [required] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision + +non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision( +comment='approved' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequest.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..bd611173d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequest.md @@ -0,0 +1,87 @@ +--- +id: non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequest', 'NonEmployeeRequest'] +slug: /tools/sdk/python/v3/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'NonEmployeeRequest'] +--- + +# NonEmployeeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**non_employee_source** | [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**approval_items** | [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**comment** | **str** | Comment of requester | [optional] +**completion_date** | **datetime** | When the request was completely approved. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [optional] +**end_date** | **datetime** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_request import NonEmployeeRequest + +non_employee_request = NonEmployeeRequest( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +non_employee_source=sailpoint.v3.models.non_employee_source_lite.NonEmployeeSourceLite( + id = 'a0303682-5e4a-44f7-bdc2-6ce6112549c1', + source_id = '2c91808568c529c60168cca6f90c1313', + name = 'Retail', + description = 'Source description', ), +data={description=Auditing}, +approval_items=[ + sailpoint.v3.models.non_employee_approval_item_base.NonEmployeeApprovalItemBase( + id = '2c1e388b-1e55-4b0a-ab5c-897f1204159c', + approver = sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), + account_name = 'test.account', + approval_status = 'APPROVED', + approval_order = 1, + comment = 'I approve', + modified = '2019-08-23T18:52:59.162Z', + created = '2019-08-23T18:40:35.772Z', ) + ], +approval_status='APPROVED', +comment='approved', +completion_date='2020-03-24T11:11:41.139-05:00', +start_date='2020-03-24T00:00-05:00', +end_date='2021-03-25T00:00-05:00', +modified='2020-03-24T11:11:41.139-05:00', +created='2020-03-24T11:11:41.139-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..773e7a41b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestBody.md @@ -0,0 +1,51 @@ +--- +id: non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestBody', 'NonEmployeeRequestBody'] +slug: /tools/sdk/python/v3/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'NonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_name** | **str** | Requested identity account name. | [required] +**first_name** | **str** | Non-Employee's first name. | [required] +**last_name** | **str** | Non-Employee's last name. | [required] +**email** | **str** | Non-Employee's email. | [required] +**phone** | **str** | Non-Employee's phone. | [required] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [required] +**source_id** | **str** | Non-Employee's source id. | [required] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**start_date** | **datetime** | Non-Employee employment start date. | [required] +**end_date** | **datetime** | Non-Employee employment end date. | [required] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody + +non_employee_request_body = NonEmployeeRequestBody( +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +source_id='2c91808568c529c60168cca6f90c1313', +data={description=Auditing}, +start_date='2020-03-24T00:00-05:00', +end_date='2021-03-25T00:00-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..db6702d8a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestLite.md @@ -0,0 +1,37 @@ +--- +id: non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestLite', 'NonEmployeeRequestLite'] +slug: /tools/sdk/python/v3/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'NonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee request id. | [optional] +**requester** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_request_lite import NonEmployeeRequestLite + +non_employee_request_lite = NonEmployeeRequestLite( +id='ac110005-7156-1150-8171-5b292e3e0084', +requester=sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..c991343c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,39 @@ +--- +id: non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestSummary', 'NonEmployeeRequestSummary'] +slug: /tools/sdk/python/v3/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'NonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **int** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**rejected** | **int** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**pending** | **int** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**non_employee_count** | **int** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_request_summary import NonEmployeeRequestSummary + +non_employee_request_summary = NonEmployeeRequestSummary( +approved=2, +rejected=2, +pending=2, +non_employee_count=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..a80904ad9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,67 @@ +--- +id: non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/python/v3/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'NonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee request id. | [optional] +**requester** | [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**account_name** | **str** | Requested identity account name. | [optional] +**first_name** | **str** | Non-Employee's first name. | [optional] +**last_name** | **str** | Non-Employee's last name. | [optional] +**email** | **str** | Non-Employee's email. | [optional] +**phone** | **str** | Non-Employee's phone. | [optional] +**manager** | **str** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**non_employee_source** | [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**data** | **map[string]str** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**approval_status** | [**ApprovalStatus**](approval-status) | | [optional] +**comment** | **str** | Comment of requester | [optional] +**completion_date** | **datetime** | When the request was completely approved. | [optional] +**start_date** | **date** | Non-Employee employment start date. | [optional] +**end_date** | **date** | Non-Employee employment end date. | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_request_without_approval_item import NonEmployeeRequestWithoutApprovalItem + +non_employee_request_without_approval_item = NonEmployeeRequestWithoutApprovalItem( +id='ac110005-7156-1150-8171-5b292e3e0084', +requester=sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ), +account_name='william.smith', +first_name='William', +last_name='Smith', +email='william.smith@example.com', +phone='5125555555', +manager='jane.doe', +non_employee_source=, +data={description=Auditing}, +approval_status='APPROVED', +comment='approved', +completion_date='2020-03-24T11:11:41.139-05:00', +start_date='Mon Mar 23 20:00:00 EDT 2020', +end_date='Wed Mar 24 20:00:00 EDT 2021', +modified='2020-03-24T11:11:41.139-05:00', +created='2020-03-24T11:11:41.139-05:00' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..569e1bc94 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,51 @@ +--- +id: non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttribute', 'NonEmployeeSchemaAttribute'] +slug: /tools/sdk/python/v3/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'NonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Schema Attribute Id | [optional] +**system** | **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to False] +**modified** | **datetime** | When the schema attribute was last modified. | [optional] +**created** | **datetime** | When the schema attribute was created. | [optional] +**type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] +**label** | **str** | Label displayed on the UI for this schema attribute. | [required] +**technical_name** | **str** | The technical name of the attribute. Must be unique per source. | [required] +**help_text** | **str** | help text displayed by UI. | [optional] +**placeholder** | **str** | Hint text that fills UI box. | [optional] +**required** | **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + +non_employee_schema_attribute = NonEmployeeSchemaAttribute( +id='ac110005-7156-1150-8171-5b292e3e0084', +system=True, +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +type='TEXT', +label='Account Name', +technical_name='account.name', +help_text='The unique identifier for the account', +placeholder='Enter a unique user name for this account.', +required=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..4d1f120b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,43 @@ +--- +id: non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttributeBody', 'NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/python/v3/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'NonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] +**label** | **str** | Label displayed on the UI for this schema attribute. | [required] +**technical_name** | **str** | The technical name of the attribute. Must be unique per source. | [required] +**help_text** | **str** | help text displayed by UI. | [optional] +**placeholder** | **str** | Hint text that fills UI box. | [optional] +**required** | **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody + +non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody( +type='TEXT', +label='Account Name', +technical_name='account.name', +help_text='The unique identifier for the account', +placeholder='Enter a unique user name for this account.', +required=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..8735af0b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,25 @@ +--- +id: non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSchemaAttributeType', 'NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/python/v3/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'NonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +Enum representing the type of data a schema attribute accepts. + +## Enum + +* `TEXT` (value: `'TEXT'`) + +* `DATE` (value: `'DATE'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSource.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSource.md new file mode 100644 index 000000000..e440adcb9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSource.md @@ -0,0 +1,55 @@ +--- +id: non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSource', 'NonEmployeeSource'] +slug: /tools/sdk/python/v3/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'NonEmployeeSource'] +--- + +# NonEmployeeSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_source import NonEmployeeSource + +non_employee_source = NonEmployeeSource( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..5c417a276 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceLite.md @@ -0,0 +1,39 @@ +--- +id: non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceLite', 'NonEmployeeSourceLite'] +slug: /tools/sdk/python/v3/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'NonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_source_lite import NonEmployeeSourceLite + +non_employee_source_lite = NonEmployeeSourceLite( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..46e105c03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,53 @@ +--- +id: non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/python/v3/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'NonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**schema_attributes** | [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_source_lite_with_schema_attributes import NonEmployeeSourceLiteWithSchemaAttributes + +non_employee_source_lite_with_schema_attributes = NonEmployeeSourceLiteWithSchemaAttributes( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +schema_attributes=[ + sailpoint.v3.models.non_employee_schema_attribute.NonEmployeeSchemaAttribute( + id = 'ac110005-7156-1150-8171-5b292e3e0084', + system = True, + modified = '2019-08-23T18:52:59.162Z', + created = '2019-08-23T18:40:35.772Z', + type = 'TEXT', + label = 'Account Name', + technical_name = 'account.name', + help_text = 'The unique identifier for the account', + placeholder = 'Enter a unique user name for this account.', + required = True, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..f09341109 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,50 @@ +--- +id: non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceRequestBody', 'NonEmployeeSourceRequestBody'] +slug: /tools/sdk/python/v3/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'NonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of non-employee source. | [required] +**description** | **str** | Description of non-employee source. | [required] +**owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] +**management_workgroup** | **str** | The ID for the management workgroup that contains source sub-admins | [optional] +**approvers** | [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**account_managers** | [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_source_request_body import NonEmployeeSourceRequestBody + +non_employee_source_request_body = NonEmployeeSourceRequestBody( +name='Retail', +description='Source description', +owner=sailpoint.v3.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ), +management_workgroup='123299', +approvers=[ + sailpoint.v3.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ) + ], +account_managers=[ + sailpoint.v3.models.non_employee_idn_user_request.NonEmployeeIdnUserRequest( + id = '2c91808570313110017040b06f344ec9', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..0de394ed6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,57 @@ +--- +id: non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/python/v3/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'NonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**cloud_external_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId + +non_employee_source_with_cloud_external_id = NonEmployeeSourceWithCloudExternalId( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +cloud_external_id='99999' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..c066623e1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,57 @@ +--- +id: non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'NonEmployeeSourceWithNECount', 'NonEmployeeSourceWithNECount'] +slug: /tools/sdk/python/v3/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'NonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Non-Employee source id. | [optional] +**source_id** | **str** | Source Id associated with this non-employee source. | [optional] +**name** | **str** | Source name associated with this non-employee source. | [optional] +**description** | **str** | Source description associated with this non-employee source. | [optional] +**approvers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**non_employee_count** | **int** | 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'. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount + +non_employee_source_with_ne_count = NonEmployeeSourceWithNECount( +id='a0303682-5e4a-44f7-bdc2-6ce6112549c1', +source_id='2c91808568c529c60168cca6f90c1313', +name='Retail', +description='Source description', +approvers=[ + sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +account_managers=[ + sailpoint.v3.models.non_employee_identity_reference_with_id.NonEmployeeIdentityReferenceWithId( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', ) + ], +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +non_employee_count=120 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectExportImportNames.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..293ff5a03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectExportImportNames.md @@ -0,0 +1,35 @@ +--- +id: object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectExportImportNames', 'ObjectExportImportNames'] +slug: /tools/sdk/python/v3/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'ObjectExportImportNames'] +--- + +# ObjectExportImportNames + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**included_names** | **[]str** | Object names to be included in a backup. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.object_export_import_names import ObjectExportImportNames + +object_export_import_names = ObjectExportImportNames( +included_names=[ + 'Test Object name' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectImportResult.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectImportResult.md new file mode 100644 index 000000000..1a0b0a9e0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectImportResult.md @@ -0,0 +1,60 @@ +--- +id: object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectImportResult', 'ObjectImportResult'] +slug: /tools/sdk/python/v3/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'ObjectImportResult'] +--- + +# ObjectImportResult + +Response model for import of a single object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] +**warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] +**errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] +**imported_objects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] +} + +## Example + +```python +from sailpoint.v3.models.object_import_result import ObjectImportResult + +object_import_result = ObjectImportResult( +infos=[ + sailpoint.v3.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +warnings=[ + sailpoint.v3.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +errors=[ + sailpoint.v3.models.config_import/export_message.Config Import/Export Message( + key = 'UNKNOWN_REFERENCE_RESOLVER', + text = 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', + details = {details=message details}, ) + ], +imported_objects=[ + sailpoint.v3.models.import_object.ImportObject( + type = 'SOURCE', + id = '2c9180835d191a86015d28455b4b232a', + name = 'HR Active Directory', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..3345f32ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,40 @@ +--- +id: object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkCreateRequest', 'ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/python/v3/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'ObjectMappingBulkCreateRequest'] +--- + +# ObjectMappingBulkCreateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_objects_mappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | [required] +} + +## Example + +```python +from sailpoint.v3.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest + +object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest( +new_objects_mappings=[ + sailpoint.v3.models.object_mapping_request.Object Mapping Request( + object_type = 'IDENTITY', + json_path = '$.name', + source_value = 'My Governance Group Name', + target_value = 'My New Governance Group Name', + enabled = False, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..9a02cac39 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,43 @@ +--- +id: object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkCreateResponse', 'ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/python/v3/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'ObjectMappingBulkCreateResponse'] +--- + +# ObjectMappingBulkCreateResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**added_objects** | [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse + +object_mapping_bulk_create_response = ObjectMappingBulkCreateResponse( +added_objects=[ + sailpoint.v3.models.object_mapping_response.Object Mapping Response( + object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4', + object_type = 'IDENTITY', + json_path = '$.name', + source_value = 'My Governance Group Name', + target_value = 'My New Governance Group Name', + enabled = False, + created = '2024-03-19T23:18:53.732Z', + modified = '2024-03-19T23:18:53.732Z', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..420a64dbc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,33 @@ +--- +id: object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/python/v3/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest'] +--- + +# ObjectMappingBulkPatchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patches** | [**map[string]List[JsonPatchOperation]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required] +} + +## Example + +```python +from sailpoint.v3.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest + +object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest( +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}]} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..65d3b8e95 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,43 @@ +--- +id: object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingBulkPatchResponse', 'ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/python/v3/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'ObjectMappingBulkPatchResponse'] +--- + +# ObjectMappingBulkPatchResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patched_objects** | [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse + +object_mapping_bulk_patch_response = ObjectMappingBulkPatchResponse( +patched_objects=[ + sailpoint.v3.models.object_mapping_response.Object Mapping Response( + object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4', + object_type = 'IDENTITY', + json_path = '$.name', + source_value = 'My Governance Group Name', + target_value = 'My New Governance Group Name', + enabled = False, + created = '2024-03-19T23:18:53.732Z', + modified = '2024-03-19T23:18:53.732Z', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..698232033 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingRequest.md @@ -0,0 +1,41 @@ +--- +id: object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingRequest', 'ObjectMappingRequest'] +slug: /tools/sdk/python/v3/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'ObjectMappingRequest'] +--- + +# ObjectMappingRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'ENTITLEMENT', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY', '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' ] | Type of the object the mapping value applies to, must be one from enum | [required] +**json_path** | **str** | JSONPath expression denoting the path within the object where the mapping value should be applied | [required] +**source_value** | **str** | Original value at the jsonPath location within the object | [required] +**target_value** | **str** | Value to be assigned at the jsonPath location within the object | [required] +**enabled** | **bool** | Whether or not this object mapping is enabled | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.object_mapping_request import ObjectMappingRequest + +object_mapping_request = ObjectMappingRequest( +object_type='IDENTITY', +json_path='$.name', +source_value='My Governance Group Name', +target_value='My New Governance Group Name', +enabled=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingResponse.md b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..bbc763b9c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ObjectMappingResponse.md @@ -0,0 +1,47 @@ +--- +id: object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ObjectMappingResponse', 'ObjectMappingResponse'] +slug: /tools/sdk/python/v3/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'ObjectMappingResponse'] +--- + +# ObjectMappingResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_mapping_id** | **str** | Id of the object mapping | [optional] +**object_type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'ENTITLEMENT', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY', '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' ] | Type of the object the mapping value applies to | [optional] +**json_path** | **str** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**source_value** | **str** | Original value at the jsonPath location within the object | [optional] +**target_value** | **str** | Value to be assigned at the jsonPath location within the object | [optional] +**enabled** | **bool** | Whether or not this object mapping is enabled | [optional] [default to False] +**created** | **str** | Object mapping creation timestamp | [optional] +**modified** | **str** | Object mapping latest update timestamp | [optional] +} + +## Example + +```python +from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse + +object_mapping_response = ObjectMappingResponse( +object_mapping_id='3d6e0144-963f-4bd6-8d8d-d77b4e507ce4', +object_type='IDENTITY', +json_path='$.name', +source_value='My Governance Group Name', +target_value='My New Governance Group Name', +enabled=False, +created='2024-03-19T23:18:53.732Z', +modified='2024-03-19T23:18:53.732Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/OktaVerificationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/OktaVerificationRequest.md new file mode 100644 index 000000000..39565f9aa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/OktaVerificationRequest.md @@ -0,0 +1,33 @@ +--- +id: okta-verification-request +title: OktaVerificationRequest +pagination_label: OktaVerificationRequest +sidebar_label: OktaVerificationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OktaVerificationRequest', 'OktaVerificationRequest'] +slug: /tools/sdk/python/v3/models/okta-verification-request +tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest', 'OktaVerificationRequest'] +--- + +# OktaVerificationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | User identifier for Verification request. The value of the user's attribute. | [required] +} + +## Example + +```python +from sailpoint.v3.models.okta_verification_request import OktaVerificationRequest + +okta_verification_request = OktaVerificationRequest( +user_id='example@mail.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Operation.md b/docs/tools/sdk/python/Reference/V3/Models/Operation.md new file mode 100644 index 000000000..4f0ed0937 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Operation.md @@ -0,0 +1,33 @@ +--- +id: operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Operation', 'Operation'] +slug: /tools/sdk/python/v3/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'Operation'] +--- + +# Operation + +Operation on a specific criteria + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `STARTS_WITH` (value: `'STARTS_WITH'`) + +* `ENDS_WITH` (value: `'ENDS_WITH'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/OriginalRequest.md b/docs/tools/sdk/python/Reference/V3/Models/OriginalRequest.md new file mode 100644 index 000000000..31b5624af --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/OriginalRequest.md @@ -0,0 +1,47 @@ +--- +id: original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OriginalRequest', 'OriginalRequest'] +slug: /tools/sdk/python/v3/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'OriginalRequest'] +--- + +# OriginalRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Account ID. | [optional] +**result** | [**Result**](result) | | [optional] +**attribute_requests** | [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**op** | **str** | Operation used. | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.original_request import OriginalRequest + +original_request = OriginalRequest( +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +result=sailpoint.v3.models.result.Result( + status = 'Manual Task Created', ), +attribute_requests=[ + sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ) + ], +op='add', +source= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..478238d75 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,34 @@ +--- +id: orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OrphanIdentitiesReportArguments', 'OrphanIdentitiesReportArguments'] +slug: /tools/sdk/python/v3/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'OrphanIdentitiesReportArguments'] +--- + +# OrphanIdentitiesReportArguments + +Arguments for Orphan Identities report (ORPHAN_IDENTITIES) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selected_formats** | **[]str** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.orphan_identities_report_arguments import OrphanIdentitiesReportArguments + +orphan_identities_report_arguments = OrphanIdentitiesReportArguments( +selected_formats=[CSV] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/OwnerDto.md b/docs/tools/sdk/python/Reference/V3/Models/OwnerDto.md new file mode 100644 index 000000000..0fdb71096 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/OwnerDto.md @@ -0,0 +1,38 @@ +--- +id: owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerDto', 'OwnerDto'] +slug: /tools/sdk/python/v3/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'OwnerDto'] +--- + +# OwnerDto + +Owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.owner_dto import OwnerDto + +owner_dto = OwnerDto( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md new file mode 100644 index 000000000..20380c19a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md @@ -0,0 +1,38 @@ +--- +id: owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReference', 'OwnerReference'] +slug: /tools/sdk/python/v3/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] +--- + +# OwnerReference + +The owner of this object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.owner_reference import OwnerReference + +owner_reference = OwnerReference( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/OwnerReferenceSegments.md b/docs/tools/sdk/python/Reference/V3/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..e913e8189 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/OwnerReferenceSegments.md @@ -0,0 +1,38 @@ +--- +id: owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OwnerReferenceSegments', 'OwnerReferenceSegments'] +slug: /tools/sdk/python/v3/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'OwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +The owner of this object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.owner_reference_segments import OwnerReferenceSegments + +owner_reference_segments = OwnerReferenceSegments( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Owns.md b/docs/tools/sdk/python/Reference/V3/Models/Owns.md new file mode 100644 index 000000000..875e5889c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Owns.md @@ -0,0 +1,69 @@ +--- +id: owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Owns', 'Owns'] +slug: /tools/sdk/python/v3/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'Owns'] +--- + +# Owns + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sources** | [**[]Reference**](reference) | | [optional] +**entitlements** | [**[]Reference**](reference) | | [optional] +**access_profiles** | [**[]Reference**](reference) | | [optional] +**roles** | [**[]Reference**](reference) | | [optional] +**apps** | [**[]Reference**](reference) | | [optional] +**governance_groups** | [**[]Reference**](reference) | | [optional] +**fallback_approver** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.owns import Owns + +owns = Owns( +sources=[ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +entitlements=[ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +access_profiles=[ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +roles=[ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +apps=[ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +governance_groups=[ + sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ) + ], +fallback_approver=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordChangeRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..98c9bc930 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordChangeRequest.md @@ -0,0 +1,41 @@ +--- +id: password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordChangeRequest', 'PasswordChangeRequest'] +slug: /tools/sdk/python/v3/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'PasswordChangeRequest'] +--- + +# PasswordChangeRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity ID that requested the password change | [optional] +**encrypted_password** | **str** | The RSA encrypted password | [optional] +**public_key_id** | **str** | The encryption key ID | [optional] +**account_id** | **str** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**source_id** | **str** | The ID of the source for which identity is requesting the password change | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_change_request import PasswordChangeRequest + +password_change_request = PasswordChangeRequest( +identity_id='8a807d4c73c545510173c545f0a002ff', +encrypted_password='XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==', +public_key_id='YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2', +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +source_id='8a807d4c73c545510173c545d4b60246' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordChangeResponse.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..1098f075d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordChangeResponse.md @@ -0,0 +1,35 @@ +--- +id: password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordChangeResponse', 'PasswordChangeResponse'] +slug: /tools/sdk/python/v3/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'PasswordChangeResponse'] +--- + +# PasswordChangeResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The password change request ID | [optional] +**state** | **Enum** [ 'IN_PROGRESS', 'FINISHED', 'FAILED' ] | Password change state | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_change_response import PasswordChangeResponse + +password_change_response = PasswordChangeResponse( +request_id='089899f13a8f4da7824996191587bab9', +state='IN_PROGRESS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordInfo.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordInfo.md new file mode 100644 index 000000000..c01c3ebdc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordInfo.md @@ -0,0 +1,47 @@ +--- +id: password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfo', 'PasswordInfo'] +slug: /tools/sdk/python/v3/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'PasswordInfo'] +--- + +# PasswordInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Identity ID | [optional] +**source_id** | **str** | source ID | [optional] +**public_key_id** | **str** | public key ID | [optional] +**public_key** | **str** | User's public key with Base64 encoding | [optional] +**accounts** | [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**policies** | **[]str** | Password constraints | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_info import PasswordInfo + +password_info = PasswordInfo( +identity_id='2c918085744fec4301746f9a5bce4605', +source_id='2c918083746f642c01746f990884012a', +public_key_id='N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh', +public_key='MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB', +accounts=[ + sailpoint.v3.models.password_info_account.PasswordInfoAccount( + account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + account_name = 'Abby.Smith', ) + ], +policies=[passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordInfoAccount.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..27f090911 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordInfoAccount.md @@ -0,0 +1,35 @@ +--- +id: password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfoAccount', 'PasswordInfoAccount'] +slug: /tools/sdk/python/v3/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'PasswordInfoAccount'] +--- + +# PasswordInfoAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**account_name** | **str** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_info_account import PasswordInfoAccount + +password_info_account = PasswordInfoAccount( +account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', +account_name='Abby.Smith' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..55ec96711 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,35 @@ +--- +id: password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordInfoQueryDTO', 'PasswordInfoQueryDTO'] +slug: /tools/sdk/python/v3/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'PasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_name** | **str** | The login name of the user | [optional] +**source_name** | **str** | The display name of the source | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_info_query_dto import PasswordInfoQueryDTO + +password_info_query_dto = PasswordInfoQueryDTO( +user_name='Abby.Smith', +source_name='My-AD' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordOrgConfig.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..fc81456ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordOrgConfig.md @@ -0,0 +1,39 @@ +--- +id: password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordOrgConfig', 'PasswordOrgConfig'] +slug: /tools/sdk/python/v3/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'PasswordOrgConfig'] +--- + +# PasswordOrgConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**custom_instructions_enabled** | **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to False] +**digit_token_enabled** | **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to False] +**digit_token_duration_minutes** | **int** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**digit_token_length** | **int** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] +} + +## Example + +```python +from sailpoint.v3.models.password_org_config import PasswordOrgConfig + +password_org_config = PasswordOrgConfig( +custom_instructions_enabled=True, +digit_token_enabled=True, +digit_token_duration_minutes=10, +digit_token_length=9 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..73ad28251 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,93 @@ +--- +id: password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordPolicyV3Dto', 'PasswordPolicyV3Dto'] +slug: /tools/sdk/python/v3/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'PasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The password policy Id. | [optional] +**description** | **str** | Description for current password policy. | [optional] +**name** | **str** | The name of the password policy. | [optional] +**date_created** | **datetime** | Date the Password Policy was created. | [optional] +**last_updated** | **datetime** | Date the Password Policy was updated. | [optional] +**first_expiration_reminder** | **int** | The number of days before expiration remaninder. | [optional] +**account_id_min_word_length** | **int** | The minimun length of account Id. By default is equals to -1. | [optional] +**account_name_min_word_length** | **int** | The minimun length of account name. By default is equals to -1. | [optional] +**min_alpha** | **int** | Maximum alpha. By default is equals to 0. | [optional] +**min_character_types** | **int** | MinCharacterTypes. By default is equals to -1. | [optional] +**max_length** | **int** | Maximum length of the password. | [optional] +**min_length** | **int** | Minimum length of the password. By default is equals to 0. | [optional] +**max_repeated_chars** | **int** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**min_lower** | **int** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**min_numeric** | **int** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**min_special** | **int** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**min_upper** | **int** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**password_expiration** | **int** | Number of days before current password expires. By default is equals to 90. | [optional] +**default_policy** | **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to False] +**enable_passwd_expiration** | **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to False] +**require_strong_authn** | **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to False] +**require_strong_auth_off_network** | **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to False] +**require_strong_auth_untrusted_geographies** | **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to False] +**use_account_attributes** | **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to False] +**use_dictionary** | **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to False] +**use_identity_attributes** | **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to False] +**validate_against_account_id** | **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to False] +**validate_against_account_name** | **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to False] +**created** | **str** | | [optional] +**modified** | **str** | | [optional] +**source_ids** | **[]str** | List of sources IDs managed by this password policy. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto + +password_policy_v3_dto = PasswordPolicyV3Dto( +id='2c91808e7d976f3b017d9f5ceae440c8', +description='Information about the Password Policy', +name='PasswordPolicy Example', +date_created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +last_updated=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +first_expiration_reminder=45, +account_id_min_word_length=4, +account_name_min_word_length=6, +min_alpha=5, +min_character_types=5, +max_length=25, +min_length=8, +max_repeated_chars=3, +min_lower=8, +min_numeric=8, +min_special=8, +min_upper=8, +password_expiration=8, +default_policy=True, +enable_passwd_expiration=True, +require_strong_authn=True, +require_strong_auth_off_network=True, +require_strong_auth_untrusted_geographies=True, +use_account_attributes=False, +use_dictionary=False, +use_identity_attributes=False, +validate_against_account_id=False, +validate_against_account_name=True, +created='', +modified='', +source_ids=[2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordStatus.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordStatus.md new file mode 100644 index 000000000..409da6289 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordStatus.md @@ -0,0 +1,39 @@ +--- +id: password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordStatus', 'PasswordStatus'] +slug: /tools/sdk/python/v3/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'PasswordStatus'] +--- + +# PasswordStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The password change request ID | [optional] +**state** | **Enum** [ 'IN_PROGRESS', 'FINISHED', 'FAILED' ] | Password change state | [optional] +**errors** | **[]str** | The errors during the password change request | [optional] +**source_ids** | **[]str** | List of source IDs in the password change request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_status import PasswordStatus + +password_status = PasswordStatus( +request_id='089899f13a8f4da7824996191587bab9', +state='IN_PROGRESS', +errors=[The password change payload is invalid], +source_ids=[2c918083746f642c01746f990884012a] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PasswordSyncGroup.md b/docs/tools/sdk/python/Reference/V3/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..9b15d8366 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PasswordSyncGroup.md @@ -0,0 +1,43 @@ +--- +id: password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PasswordSyncGroup', 'PasswordSyncGroup'] +slug: /tools/sdk/python/v3/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'PasswordSyncGroup'] +--- + +# PasswordSyncGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the sync group | [optional] +**name** | **str** | Name of the sync group | [optional] +**password_policy_id** | **str** | ID of the password policy | [optional] +**source_ids** | **[]str** | List of password managed sources IDs | [optional] +**created** | **datetime** | The date and time this sync group was created | [optional] +**modified** | **datetime** | The date and time this sync group was last modified | [optional] +} + +## Example + +```python +from sailpoint.v3.models.password_sync_group import PasswordSyncGroup + +password_sync_group = PasswordSyncGroup( +id='6881f631-3bd5-4213-9c75-8e05cc3e35dd', +name='Password Sync Group 1', +password_policy_id='2c91808d744ba0ce01746f93b6204501', +source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], +created='2023-03-16T04:00Z', +modified='2023-03-16T04:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PatOwner.md b/docs/tools/sdk/python/Reference/V3/Models/PatOwner.md new file mode 100644 index 000000000..98a04e50e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PatOwner.md @@ -0,0 +1,38 @@ +--- +id: pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatOwner', 'PatOwner'] +slug: /tools/sdk/python/v3/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'PatOwner'] +--- + +# PatOwner + +Personal access token owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Personal access token owner's DTO type. | [optional] +**id** | **str** | Personal access token owner's identity ID. | [optional] +**name** | **str** | Personal access token owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.pat_owner import PatOwner + +pat_owner = PatOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md new file mode 100644 index 000000000..9072c4be6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md @@ -0,0 +1,39 @@ +--- +id: patch-service-desk-integration-request +title: PatchServiceDeskIntegrationRequest +pagination_label: PatchServiceDeskIntegrationRequest +sidebar_label: PatchServiceDeskIntegrationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] +slug: /tools/sdk/python/v3/models/patch-service-desk-integration-request +tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] +--- + +# PatchServiceDeskIntegrationRequest + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] +} + +## Example + +```python +from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + +patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( +operations=[ + sailpoint.v3.models.json_patch_operation.JsonPatchOperation( + op = 'replace', + path = '/description', + value = New description, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PendingApproval.md b/docs/tools/sdk/python/Reference/V3/Models/PendingApproval.md new file mode 100644 index 000000000..e2eda36ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PendingApproval.md @@ -0,0 +1,136 @@ +--- +id: pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApproval', 'PendingApproval'] +slug: /tools/sdk/python/v3/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'PendingApproval'] +--- + +# PendingApproval + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The approval id. | [optional] +**access_request_id** | **str** | This is the access request id. | [optional] +**name** | **str** | The name of the approval. | [optional] +**created** | **datetime** | When the approval was created. | [optional] +**modified** | **datetime** | When the approval was modified last time. | [optional] +**request_created** | **datetime** | When the access-request was created. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**AccessItemRequestedFor**](access-item-requested-for) | | [optional] +**owner** | [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**requested_object** | [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**requester_comment** | [**CommentDto**](comment-dto) | | [optional] +**previous_reviewers_comments** | [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**forward_history** | [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**comment_required_when_rejected** | **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to False] +**action_in_process** | [**PendingApprovalAction**](pending-approval-action) | | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**remove_date_update_requested** | **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to False] +**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**sod_violation_context** | [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.pending_approval import PendingApproval + +pending_approval = PendingApproval( +id='id12345', +access_request_id='2b838de9db9babcfe646d4f274ad4238', +name='aName', +created='2017-07-11T18:45:37.098Z', +modified='2018-07-25T20:22:28.104Z', +request_created='2017-07-11T18:45:35.098Z', +request_type='GRANT_ACCESS', +requester=sailpoint.v3.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v3.models.access_item_requested_for.AccessItemRequestedFor( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ), +owner=sailpoint.v3.models.pending_approval_owner.PendingApproval_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +requested_object=sailpoint.v3.models.requestable_object_reference.RequestableObjectReference( + id = '2c9180835d2e5168015d32f890ca1581', + name = 'Applied Research Access', + description = 'Access to research information, lab results, and schematics', + type = 'ROLE', ), +requester_comment=sailpoint.v3.models.comment_dto.CommentDto( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ), +previous_reviewers_comments=[ + sailpoint.v3.models.comment_dto.CommentDto( + comment = 'This is a comment.', + created = '2017-07-11T18:45:37.098Z', + author = sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ), ) + ], +forward_history=[ + sailpoint.v3.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], +comment_required_when_rejected=True, +action_in_process='APPROVED', +remove_date='2020-07-11T00:00Z', +remove_date_update_requested=True, +current_remove_date='2020-07-11T00:00Z', +sod_violation_context=sailpoint.v3.models.sod_violation_context_check_completed.SodViolationContextCheckCompleted( + state = 'SUCCESS', + uuid = 'f73d16e9-a038-46c5-b217-1246e15fdbdd', + violation_check_result = sailpoint.v3.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v3.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PendingApprovalAction.md b/docs/tools/sdk/python/Reference/V3/Models/PendingApprovalAction.md new file mode 100644 index 000000000..b489c5459 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PendingApprovalAction.md @@ -0,0 +1,25 @@ +--- +id: pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApprovalAction', 'PendingApprovalAction'] +slug: /tools/sdk/python/v3/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'PendingApprovalAction'] +--- + +# PendingApprovalAction + +Enum represents action that is being processed on an approval. + +## Enum + +* `APPROVED` (value: `'APPROVED'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `FORWARDED` (value: `'FORWARDED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PendingApprovalOwner.md b/docs/tools/sdk/python/Reference/V3/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..4ac81a51b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PendingApprovalOwner.md @@ -0,0 +1,38 @@ +--- +id: pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PendingApprovalOwner', 'PendingApprovalOwner'] +slug: /tools/sdk/python/v3/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'PendingApprovalOwner'] +--- + +# PendingApprovalOwner + +Access item owner's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Access item owner's DTO type. | [optional] +**id** | **str** | Access item owner's identity ID. | [optional] +**name** | **str** | Access item owner's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.pending_approval_owner import PendingApprovalOwner + +pending_approval_owner = PendingApprovalOwner( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PermissionDto.md b/docs/tools/sdk/python/Reference/V3/Models/PermissionDto.md new file mode 100644 index 000000000..de859a740 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PermissionDto.md @@ -0,0 +1,38 @@ +--- +id: permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PermissionDto', 'PermissionDto'] +slug: /tools/sdk/python/v3/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'PermissionDto'] +--- + +# PermissionDto + +Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**target** | **str** | The target the permission would grants rights on. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.permission_dto import PermissionDto + +permission_dto = PermissionDto( +rights=[ + 'SELECT' + ], +target='SYS.GV_$TRANSACTION' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/python/Reference/V3/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..9fc75bca8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,38 @@ +--- +id: pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PreApprovalTriggerDetails', 'PreApprovalTriggerDetails'] +slug: /tools/sdk/python/v3/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'PreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +Provides additional details about the pre-approval trigger for this request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment left for the pre-approval decision | [optional] +**reviewer** | **str** | The reviewer of the pre-approval decision | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | The decision of the pre-approval trigger | [optional] +} + +## Example + +```python +from sailpoint.v3.models.pre_approval_trigger_details import PreApprovalTriggerDetails + +pre_approval_trigger_details = PreApprovalTriggerDetails( +comment='Access is Approved', +reviewer='John Doe', +decision='APPROVED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProcessingDetails.md b/docs/tools/sdk/python/Reference/V3/Models/ProcessingDetails.md new file mode 100644 index 000000000..49b1575d7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProcessingDetails.md @@ -0,0 +1,41 @@ +--- +id: processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProcessingDetails', 'ProcessingDetails'] +slug: /tools/sdk/python/v3/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'ProcessingDetails'] +--- + +# ProcessingDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **datetime** | A date-time in ISO-8601 format | [optional] +**stage** | **str** | | [optional] +**retry_count** | **int** | | [optional] +**stack_trace** | **str** | | [optional] +**message** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.processing_details import ProcessingDetails + +processing_details = ProcessingDetails( +var_date='2018-06-25T20:22:28.104Z', +stage='In Process', +retry_count=0, +stack_trace='', +message='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningConfig.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningConfig.md new file mode 100644 index 000000000..67a0fd19e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningConfig.md @@ -0,0 +1,44 @@ +--- +id: provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfig', 'ProvisioningConfig'] +slug: /tools/sdk/python/v3/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'ProvisioningConfig'] +--- + +# ProvisioningConfig + +Specification of a Service Desk integration provisioning configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universal_manager** | **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to False] +**managed_resource_refs** | [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**plan_initializer_script** | [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**no_provisioning_requests** | **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to False] +**provisioning_request_expiration** | **int** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_config import ProvisioningConfig + +provisioning_config = ProvisioningConfig( +universal_manager=True, +managed_resource_refs=[{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], +plan_initializer_script=sailpoint.v3.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), +no_provisioning_requests=True, +provisioning_request_expiration=7 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..aef11df45 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,35 @@ +--- +id: provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/python/v3/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'ProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +This is a reference to a plan initializer script. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **str** | This is a Rule that allows provisioning instruction changes. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_config_plan_initializer_script import ProvisioningConfigPlanInitializerScript + +provisioning_config_plan_initializer_script = ProvisioningConfigPlanInitializerScript( +source='\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..d73c263e0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,45 @@ +--- +id: provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel1', 'ProvisioningCriteriaLevel1'] +slug: /tools/sdk/python/v3/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'ProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_criteria_level1 import ProvisioningCriteriaLevel1 + +provisioning_criteria_level1 = ProvisioningCriteriaLevel1( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v3.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..7ce71c0b1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,45 @@ +--- +id: provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel2', 'ProvisioningCriteriaLevel2'] +slug: /tools/sdk/python/v3/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'ProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_criteria_level2 import ProvisioningCriteriaLevel2 + +provisioning_criteria_level2 = ProvisioningCriteriaLevel2( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v3.models.provisioning_criteria_level3.ProvisioningCriteriaLevel3( + operation = 'EQUALS', + attribute = 'email', + value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..0d028757e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,40 @@ +--- +id: provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaLevel3', 'ProvisioningCriteriaLevel3'] +slug: /tools/sdk/python/v3/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'ProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +Defines matching criteria for an Account to be provisioned with a specific Access Profile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**children** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_criteria_level3 import ProvisioningCriteriaLevel3 + +provisioning_criteria_level3 = ProvisioningCriteriaLevel3( +operation='EQUALS', +attribute='email', +value='carlee.cert1c9f9b6fd@mailinator.com', +children='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..662a48b87 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningCriteriaOperation', 'ProvisioningCriteriaOperation'] +slug: /tools/sdk/python/v3/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'ProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +Supported operations on ProvisioningCriteria + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `HAS` (value: `'HAS'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningDetails.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningDetails.md new file mode 100644 index 000000000..22868379e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningDetails.md @@ -0,0 +1,34 @@ +--- +id: provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningDetails', 'ProvisioningDetails'] +slug: /tools/sdk/python/v3/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'ProvisioningDetails'] +--- + +# ProvisioningDetails + +Provides additional details about provisioning for this request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ordered_sub_phase_references** | **str** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_details import ProvisioningDetails + +provisioning_details = ProvisioningDetails( +ordered_sub_phase_references='manualWorkItemDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningPolicy.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..604514897 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningPolicy.md @@ -0,0 +1,47 @@ +--- +id: provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningPolicy', 'ProvisioningPolicy'] +slug: /tools/sdk/python/v3/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'ProvisioningPolicy'] +--- + +# ProvisioningPolicy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the provisioning policy name | [required] +**description** | **str** | the description of the provisioning policy | [optional] +**usage_type** | [**UsageType**](usage-type) | | [optional] +**fields** | [**[]FieldDetailsDto**](field-details-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_policy import ProvisioningPolicy + +provisioning_policy = ProvisioningPolicy( +name='example provisioning policy for inactive identities', +description='this provisioning policy creates access based on an identity going inactive', +usage_type='CREATE', +fields=[ + sailpoint.v3.models.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/ProvisioningPolicyDto.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..cb6c70036 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningPolicyDto.md @@ -0,0 +1,47 @@ +--- +id: provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningPolicyDto', 'ProvisioningPolicyDto'] +slug: /tools/sdk/python/v3/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'ProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the provisioning policy name | [required] +**description** | **str** | the description of the provisioning policy | [optional] +**usage_type** | [**UsageType**](usage-type) | | [optional] +**fields** | [**[]FieldDetailsDto**](field-details-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto + +provisioning_policy_dto = ProvisioningPolicyDto( +name='example provisioning policy for inactive identities', +description='this provisioning policy creates access based on an identity going inactive', +usage_type='CREATE', +fields=[ + sailpoint.v3.models.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/ProvisioningState.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningState.md new file mode 100644 index 000000000..f2a2d8eb4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningState.md @@ -0,0 +1,31 @@ +--- +id: provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ProvisioningState', 'ProvisioningState'] +slug: /tools/sdk/python/v3/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'ProvisioningState'] +--- + +# ProvisioningState + +Provisioning state of an account activity item + +## Enum + +* `PENDING` (value: `'PENDING'`) + +* `FINISHED` (value: `'FINISHED'`) + +* `UNVERIFIABLE` (value: `'UNVERIFIABLE'`) + +* `COMMITED` (value: `'COMMITED'`) + +* `FAILED` (value: `'FAILED'`) + +* `RETRY` (value: `'RETRY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PublicIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentity.md new file mode 100644 index 000000000..7a5fde8f4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentity.md @@ -0,0 +1,56 @@ +--- +id: public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentity', 'PublicIdentity'] +slug: /tools/sdk/python/v3/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'PublicIdentity'] +--- + +# PublicIdentity + +Details about a public identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +**alias** | **str** | Alternate unique identifier for the identity. | [optional] +**email** | **str** | Email address of identity. | [optional] +**status** | **str** | The lifecycle status for the identity | [optional] +**identity_state** | **Enum** [ 'ACTIVE', 'INACTIVE_SHORT_TERM', 'INACTIVE_LONG_TERM' ] | 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. | [optional] +**manager** | [**IdentityReference**](identity-reference) | | [optional] +**attributes** | [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] +} + +## Example + +```python +from sailpoint.v3.models.public_identity import PublicIdentity + +public_identity = PublicIdentity( +id='2c9180857182305e0171993735622948', +name='Alison Ferguso', +alias='alison.ferguso', +email='alison.ferguso@acme-solar.com', +status='Active', +identity_state='ACTIVE', +manager=sailpoint.v3.models.identity_reference.IdentityReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ), +attributes=[ + sailpoint.v3.models.public_identity_attributes_inner.PublicIdentity_attributes_inner( + key = 'country', + name = 'Country', + value = 'US', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..837533f26 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,36 @@ +--- +id: public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityAttributeConfig', 'PublicIdentityAttributeConfig'] +slug: /tools/sdk/python/v3/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'PublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +Used to map an attribute key for an Identity to its display name. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The attribute key | [optional] +**name** | **str** | The attribute display name | [optional] +} + +## Example + +```python +from sailpoint.v3.models.public_identity_attribute_config import PublicIdentityAttributeConfig + +public_identity_attribute_config = PublicIdentityAttributeConfig( +key='country', +name='Country' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..3542c4dca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,37 @@ +--- +id: public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityAttributesInner', 'PublicIdentityAttributesInner'] +slug: /tools/sdk/python/v3/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'PublicIdentityAttributesInner'] +--- + +# PublicIdentityAttributesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | The attribute key | [optional] +**name** | **str** | Human-readable display name of the attribute | [optional] +**value** | **str** | The attribute value | [optional] +} + +## Example + +```python +from sailpoint.v3.models.public_identity_attributes_inner import PublicIdentityAttributesInner + +public_identity_attributes_inner = PublicIdentityAttributesInner( +key='country', +name='Country', +value='US' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityConfig.md b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..7e06d3cd5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PublicIdentityConfig.md @@ -0,0 +1,45 @@ +--- +id: public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PublicIdentityConfig', 'PublicIdentityConfig'] +slug: /tools/sdk/python/v3/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'PublicIdentityConfig'] +--- + +# PublicIdentityConfig + +Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**modified** | **datetime** | When this configuration was last modified. | [optional] +**modified_by** | [**IdentityReference**](identity-reference) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.public_identity_config import PublicIdentityConfig + +public_identity_config = PublicIdentityConfig( +attributes=[ + sailpoint.v3.models.public_identity_attribute_config.PublicIdentityAttributeConfig( + key = 'country', + name = 'Country', ) + ], +modified='2018-06-25T20:22:28.104Z', +modified_by=sailpoint.v3.models.identity_reference.IdentityReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..edc879bea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,41 @@ +--- +id: put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutClientLogConfigurationRequest', 'PutClientLogConfigurationRequest'] +slug: /tools/sdk/python/v3/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'PutClientLogConfigurationRequest'] +--- + +# PutClientLogConfigurationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_id** | **str** | Log configuration's client ID | [optional] +**duration_minutes** | **int** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**root_level** | [**StandardLevel**](standard-level) | | [required] +**log_levels** | [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**expiration** | **datetime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + +put_client_log_configuration_request = PutClientLogConfigurationRequest( +client_id='3a38a51992e8445ab51a549c0a70ee66', +duration_minutes=120, +root_level='INFO', +log_levels=INFO, +expiration='2024-11-06T01:31:08.013164Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..2be78f4e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,33 @@ +--- +id: put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutConnectorSourceConfigRequest', 'PutConnectorSourceConfigRequest'] +slug: /tools/sdk/python/v3/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'PutConnectorSourceConfigRequest'] +--- + +# PutConnectorSourceConfigRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | connector source config xml file | [required] +} + +## Example + +```python +from sailpoint.v3.models.put_connector_source_config_request import PutConnectorSourceConfigRequest + +put_connector_source_config_request = PutConnectorSourceConfigRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..63ba40180 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,33 @@ +--- +id: put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutConnectorSourceTemplateRequest', 'PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/python/v3/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'PutConnectorSourceTemplateRequest'] +--- + +# PutConnectorSourceTemplateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | connector source template xml file | [required] +} + +## Example + +```python +from sailpoint.v3.models.put_connector_source_template_request import PutConnectorSourceTemplateRequest + +put_connector_source_template_request = PutConnectorSourceTemplateRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..e701975ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,33 @@ +--- +id: put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'PutPasswordDictionaryRequest', 'PutPasswordDictionaryRequest'] +slug: /tools/sdk/python/v3/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'PutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.put_password_dictionary_request import PutPasswordDictionaryRequest + +put_password_dictionary_request = PutPasswordDictionaryRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Query.md b/docs/tools/sdk/python/Reference/V3/Models/Query.md new file mode 100644 index 000000000..cccc9adb3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Query.md @@ -0,0 +1,42 @@ +--- +id: query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Query', 'Query'] +slug: /tools/sdk/python/v3/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'Query'] +--- + +# Query + +Query parameters used to construct an Elasticsearch query object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | 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. | [optional] +**fields** | **str** | 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. | [optional] +**time_zone** | **str** | The time zone to be applied to any range query related to dates. | [optional] +**inner_hit** | [**InnerHit**](inner-hit) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.query import Query + +query = Query( +query='name:a*', +fields='[firstName,lastName,email]', +time_zone='America/Chicago', +inner_hit=sailpoint.v3.models.inner_hit.InnerHit( + query = 'source.name:\"Active Directory\"', + type = 'access', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/QueryResultFilter.md b/docs/tools/sdk/python/Reference/V3/Models/QueryResultFilter.md new file mode 100644 index 000000000..b1338a30c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/QueryResultFilter.md @@ -0,0 +1,36 @@ +--- +id: query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueryResultFilter', 'QueryResultFilter'] +slug: /tools/sdk/python/v3/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'QueryResultFilter'] +--- + +# QueryResultFilter + +Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includes** | **[]str** | The list of field names to include in the result documents. | [optional] +**excludes** | **[]str** | The list of field names to exclude from the result documents. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.query_result_filter import QueryResultFilter + +query_result_filter = QueryResultFilter( +includes=[name, displayName], +excludes=[stacktrace] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/QueryType.md b/docs/tools/sdk/python/Reference/V3/Models/QueryType.md new file mode 100644 index 000000000..8d6fce8bb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/QueryType.md @@ -0,0 +1,27 @@ +--- +id: query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueryType', 'QueryType'] +slug: /tools/sdk/python/v3/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'QueryType'] +--- + +# QueryType + +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. + +## Enum + +* `DSL` (value: `'DSL'`) + +* `SAILPOINT` (value: `'SAILPOINT'`) + +* `TEXT` (value: `'TEXT'`) + +* `TYPEAHEAD` (value: `'TYPEAHEAD'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/python/Reference/V3/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..eb8cbcdff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,36 @@ +--- +id: queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'QueuedCheckConfigDetails', 'QueuedCheckConfigDetails'] +slug: /tools/sdk/python/v3/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'QueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +Configuration of maximum number of days and interval for checking Service Desk integration queue status. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provisioning_status_check_interval_minutes** | **str** | Interval in minutes between status checks | [required] +**provisioning_max_status_check_days** | **str** | Maximum number of days to check | [required] +} + +## Example + +```python +from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails + +queued_check_config_details = QueuedCheckConfigDetails( +provisioning_status_check_interval_minutes='30', +provisioning_max_status_check_days='2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Range.md b/docs/tools/sdk/python/Reference/V3/Models/Range.md new file mode 100644 index 000000000..900eb6379 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Range.md @@ -0,0 +1,40 @@ +--- +id: range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Range', 'Range'] +slug: /tools/sdk/python/v3/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'Range'] +--- + +# Range + +The range of values to be filtered. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lower** | [**Bound**](bound) | | [optional] +**upper** | [**Bound**](bound) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.range import Range + +range = Range( +lower=sailpoint.v3.models.bound.Bound( + value = '1', + inclusive = False, ), +upper=sailpoint.v3.models.bound.Bound( + value = '1', + inclusive = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReassignReference.md b/docs/tools/sdk/python/Reference/V3/Models/ReassignReference.md new file mode 100644 index 000000000..e879e3509 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReassignReference.md @@ -0,0 +1,35 @@ +--- +id: reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignReference', 'ReassignReference'] +slug: /tools/sdk/python/v3/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'ReassignReference'] +--- + +# ReassignReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of item or identity being reassigned. | [required] +**type** | **Enum** [ 'TARGET_SUMMARY', 'ITEM', 'IDENTITY_SUMMARY' ] | The type of item or identity being reassigned. | [required] +} + +## Example + +```python +from sailpoint.v3.models.reassign_reference import ReassignReference + +reassign_reference = ReassignReference( +id='ef38f94347e94562b5bb8424a56397d8', +type='ITEM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Reassignment.md b/docs/tools/sdk/python/Reference/V3/Models/Reassignment.md new file mode 100644 index 000000000..6b8819042 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Reassignment.md @@ -0,0 +1,45 @@ +--- +id: reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reassignment', 'Reassignment'] +slug: /tools/sdk/python/v3/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'Reassignment'] +--- + +# Reassignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_from** | [**CertificationReference**](certification-reference) | | [optional] +**comment** | **str** | The comment entered when the Certification was reassigned | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reassignment import Reassignment + +reassignment = Reassignment( +var_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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReassignmentReference.md b/docs/tools/sdk/python/Reference/V3/Models/ReassignmentReference.md new file mode 100644 index 000000000..1e1e9bbda --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReassignmentReference.md @@ -0,0 +1,35 @@ +--- +id: reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentReference', 'ReassignmentReference'] +slug: /tools/sdk/python/v3/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'ReassignmentReference'] +--- + +# ReassignmentReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of item or identity being reassigned. | [required] +**type** | **Enum** [ 'TARGET_SUMMARY', 'ITEM', 'IDENTITY_SUMMARY' ] | The type of item or identity being reassigned. | [required] +} + +## Example + +```python +from sailpoint.v3.models.reassignment_reference import ReassignmentReference + +reassignment_reference = ReassignmentReference( +id='ef38f94347e94562b5bb8424a56397d8', +type='ITEM' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/python/Reference/V3/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..ccabd3488 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReassignmentTrailDTO.md @@ -0,0 +1,37 @@ +--- +id: reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentTrailDTO', 'ReassignmentTrailDTO'] +slug: /tools/sdk/python/v3/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'ReassignmentTrailDTO'] +--- + +# ReassignmentTrailDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous_owner** | **str** | The ID of previous owner identity. | [optional] +**new_owner** | **str** | The ID of new owner identity. | [optional] +**reassignment_type** | **str** | The type of reassignment. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reassignment_trail_dto import ReassignmentTrailDTO + +reassignment_trail_dto = ReassignmentTrailDTO( +previous_owner='ef38f94347e94562b5bb8424a56397d8', +new_owner='ef38f94347e94562b5bb8424a56397a3', +reassignment_type='AUTOMATIC_REASSIGNMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReassignmentType.md b/docs/tools/sdk/python/Reference/V3/Models/ReassignmentType.md new file mode 100644 index 000000000..6cc202523 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReassignmentType.md @@ -0,0 +1,27 @@ +--- +id: reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReassignmentType', 'ReassignmentType'] +slug: /tools/sdk/python/v3/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'ReassignmentType'] +--- + +# ReassignmentType + +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). + +## Enum + +* `MANUAL_REASSIGNMENT` (value: `'MANUAL_REASSIGNMENT'`) + +* `AUTOMATIC_REASSIGNMENT` (value: `'AUTOMATIC_REASSIGNMENT'`) + +* `AUTO_ESCALATION` (value: `'AUTO_ESCALATION'`) + +* `SELF_REVIEW_DELEGATION` (value: `'SELF_REVIEW_DELEGATION'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Recommendation.md b/docs/tools/sdk/python/Reference/V3/Models/Recommendation.md new file mode 100644 index 000000000..b62d469cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Recommendation.md @@ -0,0 +1,35 @@ +--- +id: recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Recommendation', 'Recommendation'] +slug: /tools/sdk/python/v3/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'Recommendation'] +--- + +# Recommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required] +**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] +} + +## Example + +```python +from sailpoint.v3.models.recommendation import Recommendation + +recommendation = Recommendation( +type='MACHINE', +method='DISCOVERY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Reference.md b/docs/tools/sdk/python/Reference/V3/Models/Reference.md new file mode 100644 index 000000000..c24575310 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Reference.md @@ -0,0 +1,35 @@ +--- +id: reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reference', 'Reference'] +slug: /tools/sdk/python/v3/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'Reference'] +--- + +# Reference + + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.reference import Reference + +reference = Reference( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RemediationItemDetails.md b/docs/tools/sdk/python/Reference/V3/Models/RemediationItemDetails.md new file mode 100644 index 000000000..f622d4765 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RemediationItemDetails.md @@ -0,0 +1,49 @@ +--- +id: remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RemediationItemDetails', 'RemediationItemDetails'] +slug: /tools/sdk/python/v3/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'RemediationItemDetails'] +--- + +# RemediationItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification | [optional] +**target_id** | **str** | The ID of the certification target | [optional] +**target_name** | **str** | The name of the certification target | [optional] +**target_display_name** | **str** | The display name of the certification target | [optional] +**application_name** | **str** | The name of the application/source | [optional] +**attribute_name** | **str** | The name of the attribute being certified | [optional] +**attribute_operation** | **str** | The operation of the certification on the attribute | [optional] +**attribute_value** | **str** | The value of the attribute being certified | [optional] +**native_identity** | **str** | The native identity of the target | [optional] +} + +## Example + +```python +from sailpoint.v3.models.remediation_item_details import RemediationItemDetails + +remediation_item_details = RemediationItemDetails( +id='2c9180835d2e5168015d32f890ca1581', +target_id='2c9180835d2e5168015d32f890ca1581', +target_name='john.smith', +target_display_name='emailAddress', +application_name='Active Directory', +attribute_name='phoneNumber', +attribute_operation='update', +attribute_value='512-555-1212', +native_identity='jason.smith2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RemediationItems.md b/docs/tools/sdk/python/Reference/V3/Models/RemediationItems.md new file mode 100644 index 000000000..b7168683e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RemediationItems.md @@ -0,0 +1,49 @@ +--- +id: remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RemediationItems', 'RemediationItems'] +slug: /tools/sdk/python/v3/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'RemediationItems'] +--- + +# RemediationItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the certification | [optional] +**target_id** | **str** | The ID of the certification target | [optional] +**target_name** | **str** | The name of the certification target | [optional] +**target_display_name** | **str** | The display name of the certification target | [optional] +**application_name** | **str** | The name of the application/source | [optional] +**attribute_name** | **str** | The name of the attribute being certified | [optional] +**attribute_operation** | **str** | The operation of the certification on the attribute | [optional] +**attribute_value** | **str** | The value of the attribute being certified | [optional] +**native_identity** | **str** | The native identity of the target | [optional] +} + +## Example + +```python +from sailpoint.v3.models.remediation_items import RemediationItems + +remediation_items = RemediationItems( +id='2c9180835d2e5168015d32f890ca1581', +target_id='2c9180835d2e5168015d32f890ca1581', +target_name='john.smith', +target_display_name='emailAddress', +application_name='Active Directory', +attribute_name='phoneNumber', +attribute_operation='update', +attribute_value='512-555-1212', +native_identity='jason.smith2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReportDetails.md b/docs/tools/sdk/python/Reference/V3/Models/ReportDetails.md new file mode 100644 index 000000000..60f32ae97 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReportDetails.md @@ -0,0 +1,36 @@ +--- +id: report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportDetails', 'ReportDetails'] +slug: /tools/sdk/python/v3/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'ReportDetails'] +--- + +# ReportDetails + +Details about report to be processed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional] +**arguments** | [**ReportDetailsArguments**](report-details-arguments) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.report_details import ReportDetails + +report_details = ReportDetails( +report_type='ACCOUNTS', +arguments={application=2c9180897e7742b2017e781782f705b9, sourceName=Active Directory} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReportDetailsArguments.md b/docs/tools/sdk/python/Reference/V3/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..2b4cc5a94 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReportDetailsArguments.md @@ -0,0 +1,50 @@ +--- +id: report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportDetailsArguments', 'ReportDetailsArguments'] +slug: /tools/sdk/python/v3/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'ReportDetailsArguments'] +--- + +# ReportDetailsArguments + +The string-object map(dictionary) with the arguments needed for report processing. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | **str** | Source ID. | [required] +**source_name** | **str** | Source name. | [required] +**correlated_only** | **bool** | Flag to specify if only correlated identities are included in report. | [required][default to False] +**authoritative_source** | **str** | Source ID. | [required] +**selected_formats** | **[]str** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**query** | **str** | 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. | [required] +**columns** | **str** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.report_details_arguments import ReportDetailsArguments + +report_details_arguments = ReportDetailsArguments( +application='2c9180897eSourceIde781782f705b9', +source_name='Active Directory', +correlated_only=True, +authoritative_source='1234sourceId5678902', +selected_formats=[CSV], +indices=[entitlements], +query='name:a*', +columns='displayName,firstName,lastName,email,created,attributes.cloudLifecycleState', +sort=[displayName, +id] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReportResultReference.md b/docs/tools/sdk/python/Reference/V3/Models/ReportResultReference.md new file mode 100644 index 000000000..adcc3a53a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReportResultReference.md @@ -0,0 +1,39 @@ +--- +id: report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportResultReference', 'ReportResultReference'] +slug: /tools/sdk/python/v3/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'ReportResultReference'] +--- + +# ReportResultReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +**status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR', 'PENDING' ] | Status of a SOD policy violation report. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.report_result_reference import ReportResultReference + +report_result_reference = ReportResultReference( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation', +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReportResults.md b/docs/tools/sdk/python/Reference/V3/Models/ReportResults.md new file mode 100644 index 000000000..13bb76cf8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReportResults.md @@ -0,0 +1,48 @@ +--- +id: report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportResults', 'ReportResults'] +slug: /tools/sdk/python/v3/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'ReportResults'] +--- + +# ReportResults + +Details about report result or current state. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional] +**task_def_name** | **str** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**id** | **str** | Unique task definition identifier. | [optional] +**created** | **datetime** | Report processing start date | [optional] +**status** | **Enum** [ 'SUCCESS', 'FAILURE', 'WARNING', 'TERMINATED' ] | Report current state or result status. | [optional] +**duration** | **int** | Report processing time in ms. | [optional] +**rows** | **int** | Report size in rows. | [optional] +**available_formats** | **[]str** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.report_results import ReportResults + +report_results = ReportResults( +report_type='IDENTITIES_DETAILS', +task_def_name='Identities Details Report', +id='a248c16fe22222b2bd49615481311111', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +status='SUCCESS', +duration=342, +rows=37, +available_formats=[CSV] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReportType.md b/docs/tools/sdk/python/Reference/V3/Models/ReportType.md new file mode 100644 index 000000000..4ae7635c7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReportType.md @@ -0,0 +1,27 @@ +--- +id: report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReportType', 'ReportType'] +slug: /tools/sdk/python/v3/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'ReportType'] +--- + +# ReportType + +type of a Report + +## Enum + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `'CAMPAIGN_COMPOSITION_REPORT'`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `'CAMPAIGN_REMEDIATION_STATUS_REPORT'`) + +* `CAMPAIGN_STATUS_REPORT` (value: `'CAMPAIGN_STATUS_REPORT'`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `'CERTIFICATION_SIGNOFF_REPORT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/python/Reference/V3/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..257950366 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,35 @@ +--- +id: request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestOnBehalfOfConfig', 'RequestOnBehalfOfConfig'] +slug: /tools/sdk/python/v3/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'RequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allow_request_on_behalf_of_anyone_by_anyone** | **bool** | If this is true, anyone can request access for anyone. | [optional] [default to False] +**allow_request_on_behalf_of_employee_by_manager** | **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.request_on_behalf_of_config import RequestOnBehalfOfConfig + +request_on_behalf_of_config = RequestOnBehalfOfConfig( +allow_request_on_behalf_of_anyone_by_anyone=True, +allow_request_on_behalf_of_employee_by_manager=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Requestability.md b/docs/tools/sdk/python/Reference/V3/Models/Requestability.md new file mode 100644 index 000000000..6388fd106 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Requestability.md @@ -0,0 +1,41 @@ +--- +id: requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Requestability', 'Requestability'] +slug: /tools/sdk/python/v3/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] +--- + +# Requestability + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requestability import Requestability + +requestability = Requestability( +comments_required=True, +denial_comments_required=True, +approval_schemes=[ + sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md new file mode 100644 index 000000000..f554dbd48 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md @@ -0,0 +1,41 @@ +--- +id: requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestabilityForRole', 'RequestabilityForRole'] +slug: /tools/sdk/python/v3/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'RequestabilityForRole'] +--- + +# RequestabilityForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requestability_for_role import RequestabilityForRole + +requestability_for_role = RequestabilityForRole( +comments_required=True, +denial_comments_required=True, +approval_schemes=[ + sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestableObject.md b/docs/tools/sdk/python/Reference/V3/Models/RequestableObject.md new file mode 100644 index 000000000..f5debd6dd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestableObject.md @@ -0,0 +1,55 @@ +--- +id: requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObject', 'RequestableObject'] +slug: /tools/sdk/python/v3/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'RequestableObject'] +--- + +# RequestableObject + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the requestable object itself | [optional] +**name** | **str** | Human-readable display name of the requestable object | [optional] +**created** | **datetime** | The time when the requestable object was created | [optional] +**modified** | **datetime** | The time when the requestable object was last modified | [optional] +**description** | **str** | Description of the requestable object. | [optional] +**type** | [**RequestableObjectType**](requestable-object-type) | | [optional] +**request_status** | [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**identity_request_id** | **str** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**owner_ref** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**request_comments_required** | **bool** | Whether the requester must provide comments when requesting the object. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requestable_object import RequestableObject + +requestable_object = RequestableObject( +id='2c9180835d2e5168015d32f890ca1581', +name='Applied Research Access', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +description='Access to research information, lab results, and schematics.', +type='ACCESS_PROFILE', +request_status=, +identity_request_id='', +owner_ref=sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +request_comments_required=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectReference.md b/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectReference.md new file mode 100644 index 000000000..2f6594dd7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectReference.md @@ -0,0 +1,39 @@ +--- +id: requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectReference', 'RequestableObjectReference'] +slug: /tools/sdk/python/v3/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'RequestableObjectReference'] +--- + +# RequestableObjectReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the object. | [optional] +**name** | **str** | Name of the object. | [optional] +**description** | **str** | Description of the object. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of the object. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requestable_object_reference import RequestableObjectReference + +requestable_object_reference = RequestableObjectReference( +id='2c9180835d2e5168015d32f890ca1581', +name='Applied Research Access', +description='Access to research information, lab results, and schematics', +type='ROLE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..b06c54dfd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,25 @@ +--- +id: requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectRequestStatus', 'RequestableObjectRequestStatus'] +slug: /tools/sdk/python/v3/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'RequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. + +## Enum + +* `AVAILABLE` (value: `'AVAILABLE'`) + +* `PENDING` (value: `'PENDING'`) + +* `ASSIGNED` (value: `'ASSIGNED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectType.md b/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectType.md new file mode 100644 index 000000000..c58a9a51a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestableObjectType.md @@ -0,0 +1,25 @@ +--- +id: requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestableObjectType', 'RequestableObjectType'] +slug: /tools/sdk/python/v3/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'RequestableObjectType'] +--- + +# RequestableObjectType + +The currently supported requestable object types. + +## Enum + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ROLE` (value: `'ROLE'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDetails.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDetails.md new file mode 100644 index 000000000..0514c9367 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDetails.md @@ -0,0 +1,35 @@ +--- +id: requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDetails', 'RequestedItemDetails'] +slug: /tools/sdk/python/v3/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'RequestedItemDetails'] +--- + +# RequestedItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ENTITLEMENT', 'ROLE' ] | The type of access item requested. | [optional] +**id** | **str** | The id of the access item requested. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_details import RequestedItemDetails + +requested_item_details = RequestedItemDetails( +type='ENTITLEMENT', +id='779c6fd7171540bba1184e5946112c28' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatus.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatus.md new file mode 100644 index 000000000..9e95e89dd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatus.md @@ -0,0 +1,144 @@ +--- +id: requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatus', 'RequestedItemStatus'] +slug: /tools/sdk/python/v3/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'RequestedItemStatus'] +--- + +# RequestedItemStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the access request. | [optional] +**name** | **str** | Human-readable display name of the item being requested. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional] +**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**approval_ids** | **[]str** | List of approval IDs associated with the request. | [optional] +**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**account_activity_item_id** | **str** | Id of associated account activity item. | [optional] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**modified** | **datetime** | When the request was last modified. | [optional] +**created** | **datetime** | When the request was created. | [optional] +**requester** | [**AccessItemRequester**](access-item-requester) | | [optional] +**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**description** | **str** | Description associated to the requested object. | [optional] +**remove_date** | **datetime** | When the role access is scheduled for removal. | [optional] +**cancelable** | **bool** | True if the request can be canceled. | [optional] [default to False] +**access_request_id** | **str** | This is the account activity id. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_status import RequestedItemStatus + +requested_item_status = RequestedItemStatus( +id='2c9180926cbfbddd016cbfc7c3b10010', +name='AccessProfile1', +type='ACCESS_PROFILE', +cancelled_request_details=, +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.', ) + ] + ], +state='EXECUTING', +approval_details=[ + sailpoint.v3.models.approval_status_dto.ApprovalStatusDto( + approval_id = '2c9180877b2b6ea4017b2c545f971429', + forwarded = False, + original_owner = sailpoint.v3.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = null, + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + scheme = 'MANAGER', + 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.', ) + ], + comment = 'I approve this request', + remove_date = '2020-07-11T00:00Z', ) + ], +approval_ids=[85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5], +manual_work_item_details=[ + sailpoint.v3.models.manual_work_item_details.ManualWorkItemDetails( + forwarded = True, + original_owner = sailpoint.v3.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), + current_owner = sailpoint.v3.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner( + type = 'IDENTITY', + id = '2c3780a46faadee4016fb4e018c20652', + name = 'Allen Albertson', ), + modified = '2019-08-23T18:52:57.398Z', + status = 'PENDING', + forward_history = [ + sailpoint.v3.models.approval_forward_history.ApprovalForwardHistory( + old_approver_name = 'Frank Mir', + new_approver_name = 'Al Volta', + comment = 'Forwarding from Frank to Al', + modified = '2019-08-23T18:52:57.398Z', + forwarder_name = 'William Wilson', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ], ) + ], +account_activity_item_id='2c9180926cbfbddd016cbfc7c3b10010', +request_type='GRANT_ACCESS', +modified='2019-08-23T18:52:59.162Z', +created='2019-08-23T18:40:35.772Z', +requester=sailpoint.v3.models.access_item_requester.AccessItemRequester( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20648', + name = 'William Wilson', ), +requested_for=sailpoint.v3.models.requested_item_status_requested_for.RequestedItemStatus_requestedFor( + type = 'IDENTITY', + id = '2c9180835d191a86015d28455b4b232a', + name = 'William Wilson', ), +requester_comment=, +sod_violation_context=, +provisioning_details=, +pre_approval_trigger_details=, +access_request_phases=[ + sailpoint.v3.models.access_request_phases.AccessRequestPhases( + started = '2020-07-11T00:00Z', + finished = '2020-07-12T00:00Z', + name = 'APPROVAL_PHASE', + state = 'COMPLETED', + result = 'SUCCESSFUL', + phase_reference = 'approvalDetails', ) + ], +description='This is the Engineering role that engineers are granted.', +remove_date='2019-10-23T00:00Z', +cancelable=True, +access_request_id='2b838de9-db9b-abcf-e646-d4f274ad4238', +client_metadata={key1=value1, key2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..67211857b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,40 @@ +--- +id: requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/python/v3/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'RequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_status_cancelled_request_details import RequestedItemStatusCancelledRequestDetails + +requested_item_status_cancelled_request_details = RequestedItemStatusCancelledRequestDetails( +comment='This request must be cancelled.', +owner=sailpoint.v3.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +modified='2019-12-20T09:17:12.192Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..d6b96301b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,37 @@ +--- +id: requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/python/v3/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'RequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment left for the pre-approval decision | [optional] +**reviewer** | **str** | The reviewer of the pre-approval decision | [optional] +**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | The decision of the pre-approval trigger | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_status_pre_approval_trigger_details import RequestedItemStatusPreApprovalTriggerDetails + +requested_item_status_pre_approval_trigger_details = RequestedItemStatusPreApprovalTriggerDetails( +comment='Access is Approved', +reviewer='John Doe', +decision='APPROVED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..f1c60f145 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,33 @@ +--- +id: requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusProvisioningDetails', 'RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/python/v3/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'RequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ordered_sub_phase_references** | **str** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_status_provisioning_details import RequestedItemStatusProvisioningDetails + +requested_item_status_provisioning_details = RequestedItemStatusProvisioningDetails( +ordered_sub_phase_references='manualWorkItemDetails' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..24e15fcbf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,37 @@ +--- +id: requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequestState', 'RequestedItemStatusRequestState'] +slug: /tools/sdk/python/v3/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'RequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. + +## Enum + +* `EXECUTING` (value: `'EXECUTING'`) + +* `REQUEST_COMPLETED` (value: `'REQUEST_COMPLETED'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +* `TERMINATED` (value: `'TERMINATED'`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `'PROVISIONING_VERIFICATION_PENDING'`) + +* `REJECTED` (value: `'REJECTED'`) + +* `PROVISIONING_FAILED` (value: `'PROVISIONING_FAILED'`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `'NOT_ALL_ITEMS_PROVISIONED'`) + +* `ERROR` (value: `'ERROR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..c700ca960 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,38 @@ +--- +id: requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequestedFor', 'RequestedItemStatusRequestedFor'] +slug: /tools/sdk/python/v3/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'RequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +Identity access was requested for. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | 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.requested_item_status_requested_for import RequestedItemStatusRequestedFor + +requested_item_status_requested_for = RequestedItemStatusRequestedFor( +type='IDENTITY', +id='2c9180835d191a86015d28455b4b232a', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..d8a561a7d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,40 @@ +--- +id: requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusRequesterComment', 'RequestedItemStatusRequesterComment'] +slug: /tools/sdk/python/v3/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'RequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Comment content. | [optional] +**created** | **datetime** | Date and time comment was created. | [optional] +**author** | [**CommentDtoAuthor**](comment-dto-author) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_status_requester_comment import RequestedItemStatusRequesterComment + +requested_item_status_requester_comment = RequestedItemStatusRequesterComment( +comment='This is a comment.', +created='2017-07-11T18:45:37.098Z', +author=sailpoint.v3.models.comment_dto_author.CommentDto_author( + type = 'IDENTITY', + id = '2c9180847e25f377017e2ae8cae4650b', + name = 'john.doe', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..5e068b9de --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,64 @@ +--- +id: requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemStatusSodViolationContext', 'RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/python/v3/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'RequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_status_sod_violation_context import RequestedItemStatusSodViolationContext + +requested_item_status_sod_violation_context = RequestedItemStatusSodViolationContext( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.v3.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v3.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Result.md b/docs/tools/sdk/python/Reference/V3/Models/Result.md new file mode 100644 index 000000000..71df6e0bd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Result.md @@ -0,0 +1,33 @@ +--- +id: result +title: Result +pagination_label: Result +sidebar_label: Result +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Result', 'Result'] +slug: /tools/sdk/python/v3/models/result +tags: ['SDK', 'Software Development Kit', 'Result', 'Result'] +--- + +# Result + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | Request result status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.result import Result + +result = Result( +status='Manual Task Created' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewDecision.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewDecision.md new file mode 100644 index 000000000..9f2560480 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewDecision.md @@ -0,0 +1,46 @@ +--- +id: review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewDecision', 'ReviewDecision'] +slug: /tools/sdk/python/v3/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'ReviewDecision'] +--- + +# ReviewDecision + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the review decision | [required] +**decision** | [**CertificationDecision**](certification-decision) | | [required] +**proposed_end_date** | **datetime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**bulk** | **bool** | Indicates whether decision should be marked as part of a larger bulk decision | [required] +**recommendation** | [**ReviewRecommendation**](review-recommendation) | | [optional] +**comments** | **str** | Comments recorded when the decision was made | [optional] +} + +## Example + +```python +from sailpoint.v3.models.review_decision import ReviewDecision + +review_decision = ReviewDecision( +id='ef38f94347e94562b5bb8424a56397d8', +decision='APPROVE', +proposed_end_date='2017-07-11T18:45:37.098Z', +bulk=True, +recommendation=sailpoint.v3.models.review_recommendation.ReviewRecommendation( + recommendation = '', + reasons = [Reason 1, Reason 2], + timestamp = '2020-06-01T13:49:37.385Z', ), +comments='This user no longer needs access to this source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewReassign.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewReassign.md new file mode 100644 index 000000000..1a6677cfe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewReassign.md @@ -0,0 +1,41 @@ +--- +id: review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewReassign', 'ReviewReassign'] +slug: /tools/sdk/python/v3/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'ReviewReassign'] +--- + +# ReviewReassign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign** | [**[]ReassignReference**](reassign-reference) | | [required] +**reassign_to** | **str** | The ID of the identity to which the certification is reassigned | [required] +**reason** | **str** | The reason comment for why the reassign was made | [required] +} + +## Example + +```python +from sailpoint.v3.models.review_reassign import ReviewReassign + +review_reassign = ReviewReassign( +reassign=[ + sailpoint.v3.models.reassign_reference.ReassignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + type = 'ITEM', ) + ], +reassign_to='ef38f94347e94562b5bb8424a56397d8', +reason='reassigned for some reason' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewRecommendation.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewRecommendation.md new file mode 100644 index 000000000..065d0e313 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewRecommendation.md @@ -0,0 +1,37 @@ +--- +id: review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewRecommendation', 'ReviewRecommendation'] +slug: /tools/sdk/python/v3/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'ReviewRecommendation'] +--- + +# ReviewRecommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommendation** | **str** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**reasons** | **[]str** | A list of reasons for the recommendation. | [optional] +**timestamp** | **datetime** | The time at which the recommendation was recorded. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.review_recommendation import ReviewRecommendation + +review_recommendation = ReviewRecommendation( +recommendation='', +reasons=[Reason 1, Reason 2], +timestamp='2020-06-01T13:49:37.385Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewableAccessProfile.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..7d0cebcb8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewableAccessProfile.md @@ -0,0 +1,104 @@ +--- +id: reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableAccessProfile', 'ReviewableAccessProfile'] +slug: /tools/sdk/python/v3/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'ReviewableAccessProfile'] +--- + +# ReviewableAccessProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Access Profile | [optional] +**name** | **str** | Name of the Access Profile | [optional] +**description** | **str** | Information about the Access Profile | [optional] +**privileged** | **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] +**end_date** | **datetime** | The date at which a user's access expires | [optional] +**owner** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**entitlements** | [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**created** | **datetime** | Date the Access Profile was created. | [optional] +**modified** | **datetime** | Date the Access Profile was last modified. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reviewable_access_profile import ReviewableAccessProfile + +reviewable_access_profile = ReviewableAccessProfile( +id='2c91808a7190d06e01719938fcd20792', +name='Employee-database-read-write', +description='Collection of entitlements to read/write the employee database', +privileged=False, +cloud_governed=False, +end_date='2021-12-25T00:00Z', +owner=sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +entitlements=[ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], +created='2021-01-01T22:32:58.104Z', +modified='2021-02-01T22:32:58.104Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlement.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..a2aaaf9c6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlement.md @@ -0,0 +1,99 @@ +--- +id: reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableEntitlement', 'ReviewableEntitlement'] +slug: /tools/sdk/python/v3/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'ReviewableEntitlement'] +--- + +# ReviewableEntitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id for the entitlement | [optional] +**name** | **str** | The name of the entitlement | [optional] +**description** | **str** | Information about the entitlement | [optional] +**privileged** | **bool** | Indicates if the entitlement is a privileged entitlement | [optional] [default to False] +**owner** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**attribute_name** | **str** | The name of the attribute on the source | [optional] +**attribute_value** | **str** | The value of the attribute on the source | [optional] +**source_schema_object_type** | **str** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**source_name** | **str** | The name of the source for which this entitlement belongs | [optional] +**source_type** | **str** | The type of the source for which the entitlement belongs | [optional] +**source_id** | **str** | The ID of the source for which the entitlement belongs | [optional] +**has_permissions** | **bool** | Indicates if the entitlement has permissions | [optional] [default to False] +**is_permission** | **bool** | Indicates if the entitlement is a representation of an account permission | [optional] [default to False] +**revocable** | **bool** | Indicates whether the entitlement can be revoked | [optional] [default to False] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] [default to False] +**contains_data_access** | **bool** | True if the entitlement has DAS data | [optional] [default to False] +**data_access** | [**DataAccess**](data-access) | | [optional] +**account** | [**ReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reviewable_entitlement import ReviewableEntitlement + +reviewable_entitlement = ReviewableEntitlement( +id='2c918085718230600171993742c63558', +name='CN=entitlement.bbb7c650', +description='Gives read/write access to the company database', +privileged=False, +owner=sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +attribute_name='memberOf', +attribute_value='CN=entitlement.bbb7c650', +source_schema_object_type='groups', +source_name='ODS-AD-Source', +source_type='Active Directory - Direct', +source_id='78ca6be511cb41fbb86dba2fcca7780c', +has_permissions=False, +is_permission=False, +revocable=True, +cloud_governed=False, +contains_data_access=True, +data_access=sailpoint.v3.models.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', ), ), +account=sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', + owner = sailpoint.v3.models.reviewable_entitlement_account_owner.ReviewableEntitlement_account_owner( + id = '2c9180857182305e0171993737eb29e8', + display_name = 'Alison Ferguson', ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..249bbfae1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,62 @@ +--- +id: reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableEntitlementAccount', 'ReviewableEntitlementAccount'] +slug: /tools/sdk/python/v3/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'ReviewableEntitlementAccount'] +--- + +# ReviewableEntitlementAccount + +Information about the status of the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**native_identity** | **str** | The native identity for this account | [optional] +**disabled** | **bool** | Indicates whether this account is currently disabled | [optional] [default to False] +**locked** | **bool** | Indicates whether this account is currently locked | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The id associated with the account | [optional] +**name** | **str** | The account name | [optional] +**created** | **datetime** | When the account was created | [optional] +**modified** | **datetime** | When the account was last modified | [optional] +**activity_insights** | [**ActivityInsights**](activity-insights) | | [optional] +**description** | **str** | Information about the account | [optional] +**governance_group_id** | **str** | The id associated with the machine Account Governance Group | [optional] +**owner** | [**ReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reviewable_entitlement_account import ReviewableEntitlementAccount + +reviewable_entitlement_account = ReviewableEntitlementAccount( +native_identity='CN=Alison Ferguso', +disabled=False, +locked=False, +type='IDENTITY', +id='2c9180857182305e0171993737eb29e6', +name='Alison Ferguso', +created='2020-04-20T20:11:05.067Z', +modified='2020-05-20T18:57:16.987Z', +activity_insights=sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), +description='Account for Read/write to the company database', +governance_group_id='2c9180857182305e0171993737eb29e6', +owner=sailpoint.v3.models.reviewable_entitlement_account_owner.ReviewableEntitlement_account_owner( + id = '2c9180857182305e0171993737eb29e8', + type = 'IDENTITY', + display_name = 'Alison Ferguson', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..a4ea2a7f1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,38 @@ +--- +id: reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableEntitlementAccountOwner', 'ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/python/v3/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'ReviewableEntitlementAccountOwner'] +--- + +# ReviewableEntitlementAccountOwner + +Information about the machine account owner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id associated with the machine account owner | [optional] +**type** | **Enum** [ 'IDENTITY' ] | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**display_name** | **str** | The machine account owner's display name | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reviewable_entitlement_account_owner import ReviewableEntitlementAccountOwner + +reviewable_entitlement_account_owner = ReviewableEntitlementAccountOwner( +id='2c9180857182305e0171993737eb29e8', +type='IDENTITY', +display_name='Alison Ferguson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ReviewableRole.md b/docs/tools/sdk/python/Reference/V3/Models/ReviewableRole.md new file mode 100644 index 000000000..7e86ce934 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ReviewableRole.md @@ -0,0 +1,162 @@ +--- +id: reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ReviewableRole', 'ReviewableRole'] +slug: /tools/sdk/python/v3/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'ReviewableRole'] +--- + +# ReviewableRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id for the Role | [optional] +**name** | **str** | The name of the Role | [optional] +**description** | **str** | Information about the Role | [optional] +**privileged** | **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**owner** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**revocable** | **bool** | Indicates whether the Role can be revoked or requested | [optional] +**end_date** | **datetime** | The date when a user's access expires. | [optional] +**access_profiles** | [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**entitlements** | [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reviewable_role import ReviewableRole + +reviewable_role = ReviewableRole( +id='2c91808a7190d06e0171993907fd0794', +name='Accounting-Employees', +description='Role for members of the accounting department with the necessary Access Profiles', +privileged=False, +owner=sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), +revocable=False, +end_date='2021-12-25T00:00Z', +access_profiles=[ + sailpoint.v3.models.reviewable_access_profile.ReviewableAccessProfile( + id = '2c91808a7190d06e01719938fcd20792', + name = 'Employee-database-read-write', + description = 'Collection of entitlements to read/write the employee database', + privileged = False, + cloud_governed = False, + end_date = '2021-12-25T00:00Z', + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + entitlements = [ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ], + created = '2021-01-01T22:32:58.104Z', + modified = '2021-02-01T22:32:58.104Z', ) + ], +entitlements=[ + sailpoint.v3.models.reviewable_entitlement.ReviewableEntitlement( + id = '2c918085718230600171993742c63558', + name = 'CN=entitlement.bbb7c650', + description = 'Gives read/write access to the company database', + privileged = False, + owner = sailpoint.v3.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail( + type = 'IDENTITY', + id = '5168015d32f890ca15812c9180835d2e', + name = 'Alison Ferguso', + email = 'alison.ferguso@identitysoon.com', ), + attribute_name = 'memberOf', + attribute_value = 'CN=entitlement.bbb7c650', + source_schema_object_type = 'groups', + source_name = 'ODS-AD-Source', + source_type = 'Active Directory - Direct', + source_id = '78ca6be511cb41fbb86dba2fcca7780c', + has_permissions = False, + is_permission = False, + revocable = True, + cloud_governed = False, + contains_data_access = True, + data_access = sailpoint.v3.models.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', ), ), + account = sailpoint.v3.models.reviewable_entitlement_account.ReviewableEntitlement_account( + native_identity = 'CN=Alison Ferguso', + disabled = False, + locked = False, + type = 'IDENTITY', + id = '2c9180857182305e0171993737eb29e6', + name = 'Alison Ferguso', + created = '2020-04-20T20:11:05.067Z', + modified = '2020-05-20T18:57:16.987Z', + activity_insights = sailpoint.v3.models.activity_insights.ActivityInsights( + account_id = 'c4ddd5421d8549f0abd309162cafd3b1', + usage_days = 45, + usage_days_state = 'COMPLETE', ), + description = 'Account for Read/write to the company database', + governance_group_id = '2c9180857182305e0171993737eb29e6', ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Reviewer.md b/docs/tools/sdk/python/Reference/V3/Models/Reviewer.md new file mode 100644 index 000000000..7a848a364 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Reviewer.md @@ -0,0 +1,43 @@ +--- +id: reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reviewer', 'Reviewer'] +slug: /tools/sdk/python/v3/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'Reviewer'] +--- + +# Reviewer + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the reviewer. | [optional] +**name** | **str** | The name of the reviewer. | [optional] +**email** | **str** | The email of the reviewing identity. | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of the reviewing identity. | [optional] +**created** | **datetime** | The created date of the reviewing identity. | [optional] +**modified** | **datetime** | The modified date of the reviewing identity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.reviewer import Reviewer + +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Revocability.md b/docs/tools/sdk/python/Reference/V3/Models/Revocability.md new file mode 100644 index 000000000..b0c12624f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Revocability.md @@ -0,0 +1,37 @@ +--- +id: revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Revocability', 'Revocability'] +slug: /tools/sdk/python/v3/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] +--- + +# Revocability + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.revocability import Revocability + +revocability = Revocability( +approval_schemes=[ + sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RevocabilityForRole.md b/docs/tools/sdk/python/Reference/V3/Models/RevocabilityForRole.md new file mode 100644 index 000000000..3b99fa5b2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RevocabilityForRole.md @@ -0,0 +1,41 @@ +--- +id: revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RevocabilityForRole', 'RevocabilityForRole'] +slug: /tools/sdk/python/v3/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'RevocabilityForRole'] +--- + +# RevocabilityForRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] +**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.revocability_for_role import RevocabilityForRole + +revocability_for_role = RevocabilityForRole( +comments_required=False, +denial_comments_required=False, +approval_schemes=[ + sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Role.md b/docs/tools/sdk/python/Reference/V3/Models/Role.md new file mode 100644 index 000000000..30ef8193b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Role.md @@ -0,0 +1,119 @@ +--- +id: role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Role', 'Role'] +slug: /tools/sdk/python/v3/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'Role'] +--- + +# Role + +A Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**name** | **str** | The human-readable display name of the Role | [required] +**created** | **datetime** | Date the Role was created | [optional] [readonly] +**modified** | **datetime** | Date the Role was last modified. | [optional] [readonly] +**description** | **str** | A human-readable description of the Role | [optional] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**access_profiles** | [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | | [optional] +**membership** | [**RoleMembershipSelector**](role-membership-selector) | | [optional] +**legacy_membership_info** | **map[string]object** | 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. | [optional] +**enabled** | **bool** | Whether the Role is enabled or not. | [optional] [default to False] +**requestable** | **bool** | Whether the Role can be the target of access requests. | [optional] [default to False] +**access_request_config** | [**RequestabilityForRole**](requestability-for-role) | | [optional] +**revocation_request_config** | [**RevocabilityForRole**](revocability-for-role) | | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**dimensional** | **bool** | Whether the Role is dimensional. | [optional] [default to False] +**dimension_refs** | [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**access_model_metadata** | [**AttributeDTOList**](attribute-dto-list) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role import Role + +role = Role( +id='2c918086749d78830174a1a40e121518', +name='Role 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.v3.models.owner_reference.OwnerReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +access_profiles=[ + sailpoint.v3.models.access_profile_ref.AccessProfileRef( + id = 'ff808081751e6e129f1518161919ecca', + type = 'ACCESS_PROFILE', + name = 'Access Profile 2567', ) + ], +entitlements=[ + sailpoint.v3.models.entitlement_ref.EntitlementRef( + type = 'ENTITLEMENT', + id = '2c91809773dee32014e13e122092014e', + name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', ) + ], +membership=sailpoint.v3.models.role_membership_selector.RoleMembershipSelector( + type = 'IDENTITY_LIST', + criteria = sailpoint.v3.models.role_criteria_level1.RoleCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v3.models.role_criteria_level2.RoleCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), + identities = [ + sailpoint.v3.models.role_membership_identity.RoleMembershipIdentity( + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', + alias_name = 't.edison', ) + ], ), +legacy_membership_info={type=IDENTITY_LIST}, +enabled=True, +requestable=True, +access_request_config=sailpoint.v3.models.requestability_for_role.RequestabilityForRole( + comments_required = True, + denial_comments_required = True, + approval_schemes = [ + sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +revocation_request_config=sailpoint.v3.models.revocability_for_role.RevocabilityForRole( + comments_required = False, + denial_comments_required = False, + approval_schemes = [ + sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( + approver_type = 'GOVERNANCE_GROUP', + approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', ) + ], ), +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +dimensional=True, +dimension_refs=[ + sailpoint.v3.models.dimension_ref.DimensionRef( + type = 'DIMENSION', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Role 2', ) + ], +access_model_metadata=sailpoint.v3.models.attribute_dto_list.AttributeDTOList( + 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}]}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/python/Reference/V3/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..183da3204 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleAssignmentSourceType.md @@ -0,0 +1,23 @@ +--- +id: role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleAssignmentSourceType', 'RoleAssignmentSourceType'] +slug: /tools/sdk/python/v3/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'RoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +Type which indicates how a particular Identity obtained a particular Role + +## Enum + +* `ACCESS_REQUEST` (value: `'ACCESS_REQUEST'`) + +* `ROLE_MEMBERSHIP` (value: `'ROLE_MEMBERSHIP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/V3/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..092fb0b3d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleBulkDeleteRequest', 'RoleBulkDeleteRequest'] +slug: /tools/sdk/python/v3/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'RoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role_ids** | **[]str** | List of IDs of Roles to be deleted. | [required] +} + +## Example + +```python +from sailpoint.v3.models.role_bulk_delete_request import RoleBulkDeleteRequest + +role_bulk_delete_request = RoleBulkDeleteRequest( +role_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaKey.md b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..b142dd16c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaKey.md @@ -0,0 +1,38 @@ +--- +id: role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaKey', 'RoleCriteriaKey'] +slug: /tools/sdk/python/v3/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'RoleCriteriaKey'] +--- + +# RoleCriteriaKey + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] +**var_property** | **str** | The name of the attribute or entitlement to which the associated criteria applies. | [required] +**source_id** | **str** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_criteria_key import RoleCriteriaKey + +role_criteria_key = RoleCriteriaKey( +type='ACCOUNT', +var_property='attribute.email', +source_id='2c9180867427f3a301745aec18211519' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..e85009ff6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaKeyType.md @@ -0,0 +1,25 @@ +--- +id: role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaKeyType', 'RoleCriteriaKeyType'] +slug: /tools/sdk/python/v3/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'RoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. + +## Enum + +* `IDENTITY` (value: `'IDENTITY'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..fdcaff80f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel1.md @@ -0,0 +1,51 @@ +--- +id: role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel1', 'RoleCriteriaLevel1'] +slug: /tools/sdk/python/v3/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'RoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +**children** | [**[]RoleCriteriaLevel2**](role-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.v3.models.role_criteria_level1 import RoleCriteriaLevel1 + +role_criteria_level1 = RoleCriteriaLevel1( +operation='EQUALS', +key=sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v3.models.role_criteria_level2.RoleCriteriaLevel2( + operation = 'EQUALS', + key = sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..f91b1a5f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel2.md @@ -0,0 +1,51 @@ +--- +id: role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel2', 'RoleCriteriaLevel2'] +slug: /tools/sdk/python/v3/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'RoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +**children** | [**[]RoleCriteriaLevel3**](role-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.v3.models.role_criteria_level2 import RoleCriteriaLevel2 + +role_criteria_level2 = RoleCriteriaLevel2( +operation='EQUALS', +key=sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v3.models.role_criteria_level3.RoleCriteriaLevel3( + operation = 'EQUALS', + key = sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..0b86e9b04 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaLevel3.md @@ -0,0 +1,41 @@ +--- +id: role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaLevel3', 'RoleCriteriaLevel3'] +slug: /tools/sdk/python/v3/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'RoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**key** | [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**string_value** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_criteria_level3 import RoleCriteriaLevel3 + +role_criteria_level3 = RoleCriteriaLevel3( +operation='EQUALS', +key=sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaOperation.md b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..cc2f55110 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleCriteriaOperation.md @@ -0,0 +1,33 @@ +--- +id: role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleCriteriaOperation', 'RoleCriteriaOperation'] +slug: /tools/sdk/python/v3/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'RoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +An operation + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `NOT_EQUALS` (value: `'NOT_EQUALS'`) + +* `CONTAINS` (value: `'CONTAINS'`) + +* `STARTS_WITH` (value: `'STARTS_WITH'`) + +* `ENDS_WITH` (value: `'ENDS_WITH'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleDocument.md b/docs/tools/sdk/python/Reference/V3/Models/RoleDocument.md new file mode 100644 index 000000000..361880631 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleDocument.md @@ -0,0 +1,106 @@ +--- +id: role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocument', 'RoleDocument'] +slug: /tools/sdk/python/v3/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'RoleDocument'] +--- + +# RoleDocument + +Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Access item's description. | [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] +**synced** | **datetime** | 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] +**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False] +**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True] +**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False] +**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional] +**id** | **str** | ID of the role. | [required] +**name** | **str** | Name of the role. | [required] +**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**access_profile_count** | **int** | Number of access profiles included with the role. | [optional] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**segment_count** | **int** | Number of segments with the role. | [optional] +**entitlements** | [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional] +**entitlement_count** | **int** | Number of entitlements included with the role. | [optional] +**dimensional** | **bool** | | [optional] [default to False] +**dimension_schema_attribute_count** | **int** | Number of dimension attributes included with the role. | [optional] +**dimension_schema_attributes** | [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional] +**dimensions** | [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_document import RoleDocument + +role_document = RoleDocument( +description='Admin access', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:33.104Z', +enabled=True, +requestable=True, +request_comments_required=False, +owner=sailpoint.v3.models.base_access_owner.BaseAccess_owner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', + email = 'cloud-support@sailpoint.com', ), +id='2c91808375d8e80a0175e1f88a575222', +name='Branch Manager Access', +access_profiles=[ + sailpoint.v3.models.base_access_profile.BaseAccessProfile( + id = '2c91809c6faade77016fb4f0b63407ae', + name = 'Admin Access', ) + ], +access_profile_count=1, +tags=[TAG_1, TAG_2], +segments=[ + sailpoint.v3.models.base_segment.BaseSegment( + id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', + name = 'Test Segment', ) + ], +segment_count=1, +entitlements=[ + null + ], +entitlement_count=3, +dimensional=False, +dimension_schema_attribute_count=3, +dimension_schema_attributes=[ + sailpoint.v3.models.role_document_all_of_dimension_schema_attributes.RoleDocument_allOf_dimensionSchemaAttributes( + derived = True, + display_name = 'Department', + name = 'department', ) + ], +dimensions=[ + sailpoint.v3.models.role_document_all_of_dimensions.RoleDocument_allOf_dimensions( + id = 'b3c28992ba964a40a7598978139d1ced', + name = 'Manager Austin Branch', + description = 'Managers located at the Austin branch', + entitlements = [ + null + ], + access_profiles = [ + sailpoint.v3.models.base_access_profile.BaseAccessProfile( + id = '2c91809c6faade77016fb4f0b63407ae', + name = 'Admin Access', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md new file mode 100644 index 000000000..2223cedac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md @@ -0,0 +1,37 @@ +--- +id: role-document-all-of-dimension-schema-attributes +title: RoleDocumentAllOfDimensionSchemaAttributes +pagination_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes'] +slug: /tools/sdk/python/v3/models/role-document-all-of-dimension-schema-attributes +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes'] +--- + +# RoleDocumentAllOfDimensionSchemaAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**derived** | **bool** | | [optional] [default to True] +**display_name** | **str** | Displayname of the dimension attribute. | [optional] +**name** | **str** | Name of the dimension attribute. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_document_all_of_dimension_schema_attributes import RoleDocumentAllOfDimensionSchemaAttributes + +role_document_all_of_dimension_schema_attributes = RoleDocumentAllOfDimensionSchemaAttributes( +derived=True, +display_name='Department', +name='department' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensions.md b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensions.md new file mode 100644 index 000000000..c23d06dbe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensions.md @@ -0,0 +1,47 @@ +--- +id: role-document-all-of-dimensions +title: RoleDocumentAllOfDimensions +pagination_label: RoleDocumentAllOfDimensions +sidebar_label: RoleDocumentAllOfDimensions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions'] +slug: /tools/sdk/python/v3/models/role-document-all-of-dimensions +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions'] +--- + +# RoleDocumentAllOfDimensions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique ID of the dimension. | [optional] +**name** | **str** | Name of the dimension. | [optional] +**description** | **str** | Description of the dimension. | [optional] +**entitlements** | [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional] +**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_document_all_of_dimensions import RoleDocumentAllOfDimensions + +role_document_all_of_dimensions = RoleDocumentAllOfDimensions( +id='b3c28992ba964a40a7598978139d1ced', +name='Manager Austin Branch', +description='Managers located at the Austin branch', +entitlements=[ + null + ], +access_profiles=[ + sailpoint.v3.models.base_access_profile.BaseAccessProfile( + id = '2c91809c6faade77016fb4f0b63407ae', + name = 'Admin Access', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements.md new file mode 100644 index 000000000..28d67dfca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements.md @@ -0,0 +1,51 @@ +--- +id: role-document-all-of-entitlements +title: RoleDocumentAllOfEntitlements +pagination_label: RoleDocumentAllOfEntitlements +sidebar_label: RoleDocumentAllOfEntitlements +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements'] +slug: /tools/sdk/python/v3/models/role-document-all-of-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements'] +--- + +# RoleDocumentAllOfEntitlements + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False] +**description** | **str** | Entitlement's description. | [optional] +**attribute** | **str** | Entitlement attribute's name. | [optional] +**value** | **str** | Entitlement's value. | [optional] +**var_schema** | **str** | Entitlement's schema. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's name. | [optional] +**source_schema_object_type** | **str** | Schema objectType. | [optional] +**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_document_all_of_entitlements import RoleDocumentAllOfEntitlements + +role_document_all_of_entitlements = RoleDocumentAllOfEntitlements( +has_permissions=False, +description='Cloud engineering', +attribute='memberOf', +value='CN=Cloud Engineering,DC=sailpoint,DC=COM', +var_schema='group', +privileged=False, +id='2c918084575812550157589064f33b89', +name='CN=Cloud Engineering,DC=sailpoint,DC=COM', +source_schema_object_type='group', +hash='c6fab95235584cca98a454a2f51e5683bc77d6a0' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md new file mode 100644 index 000000000..3eaba47e3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md @@ -0,0 +1,51 @@ +--- +id: role-document-all-of-entitlements1 +title: RoleDocumentAllOfEntitlements1 +pagination_label: RoleDocumentAllOfEntitlements1 +sidebar_label: RoleDocumentAllOfEntitlements1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1'] +slug: /tools/sdk/python/v3/models/role-document-all-of-entitlements1 +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1'] +--- + +# RoleDocumentAllOfEntitlements1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False] +**description** | **str** | Entitlement's description. | [optional] +**attribute** | **str** | Entitlement attribute's name. | [optional] +**value** | **str** | Entitlement's value. | [optional] +**var_schema** | **str** | Entitlement's schema. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's name. | [optional] +**source_schema_object_type** | **str** | Schema objectType. | [optional] +**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_document_all_of_entitlements1 import RoleDocumentAllOfEntitlements1 + +role_document_all_of_entitlements1 = RoleDocumentAllOfEntitlements1( +has_permissions=False, +description='Cloud engineering', +attribute='memberOf', +value='CN=Cloud Engineering,DC=sailpoint,DC=COM', +var_schema='group', +privileged=False, +id='2c918084575812550157589064f33b89', +name='CN=Cloud Engineering,DC=sailpoint,DC=COM', +source_schema_object_type='group', +hash='c6fab95235584cca98a454a2f51e5683bc77d6a0' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/RoleIdentity.md new file mode 100644 index 000000000..e0f0ffe0b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleIdentity.md @@ -0,0 +1,42 @@ +--- +id: role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleIdentity', 'RoleIdentity'] +slug: /tools/sdk/python/v3/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'RoleIdentity'] +--- + +# RoleIdentity + +A subset of the fields of an Identity which is a member of a Role. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the Identity | [optional] +**alias_name** | **str** | The alias / username of the Identity | [optional] +**name** | **str** | The human-readable display name of the Identity | [optional] +**email** | **str** | Email address of the Identity | [optional] +**role_assignment_source** | [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_identity import RoleIdentity + +role_identity = RoleIdentity( +id='2c9180a46faadee4016fb4e018c20639', +alias_name='t.edison', +name='Thomas Edison', +email='t.edison@identitynow.com', +role_assignment_source='ACCESS_REQUEST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipIdentity.md b/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..8a18f116f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipIdentity.md @@ -0,0 +1,40 @@ +--- +id: role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipIdentity', 'RoleMembershipIdentity'] +slug: /tools/sdk/python/v3/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'RoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +A reference to an Identity in an IDENTITY_LIST role membership criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Identity id | [optional] +**name** | **str** | Human-readable display name of the Identity. | [optional] +**alias_name** | **str** | User name of the Identity | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_membership_identity import RoleMembershipIdentity + +role_membership_identity = RoleMembershipIdentity( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison', +alias_name='t.edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipSelector.md b/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..ebd18d22e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipSelector.md @@ -0,0 +1,54 @@ +--- +id: role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipSelector', 'RoleMembershipSelector'] +slug: /tools/sdk/python/v3/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'RoleMembershipSelector'] +--- + +# RoleMembershipSelector + +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 + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**criteria** | [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**identities** | [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_membership_selector import RoleMembershipSelector + +role_membership_selector = RoleMembershipSelector( +type='IDENTITY_LIST', +criteria=sailpoint.v3.models.role_criteria_level1.RoleCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.v3.models.role_criteria_key.RoleCriteriaKey( + type = 'ACCOUNT', + property = 'attribute.email', + source_id = '2c9180867427f3a301745aec18211519', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v3.models.role_criteria_level2.RoleCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), +identities=[ + sailpoint.v3.models.role_membership_identity.RoleMembershipIdentity( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', + alias_name = 't.edison', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..39ff7307d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleMembershipSelectorType.md @@ -0,0 +1,23 @@ +--- +id: role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleMembershipSelectorType', 'RoleMembershipSelectorType'] +slug: /tools/sdk/python/v3/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'RoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +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 + +## Enum + +* `STANDARD` (value: `'STANDARD'`) + +* `IDENTITY_LIST` (value: `'IDENTITY_LIST'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RoleSummary.md b/docs/tools/sdk/python/Reference/V3/Models/RoleSummary.md new file mode 100644 index 000000000..7f5237fef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RoleSummary.md @@ -0,0 +1,48 @@ +--- +id: role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RoleSummary', 'RoleSummary'] +slug: /tools/sdk/python/v3/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'RoleSummary'] +--- + +# RoleSummary + +Role + +## 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] +**owner** | [**DisplayReference**](display-reference) | | [optional] +**disabled** | **bool** | | [optional] +**revocable** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.role_summary import RoleSummary + +role_summary = RoleSummary( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ROLE', +owner=, +disabled=True, +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SavedSearch.md b/docs/tools/sdk/python/Reference/V3/Models/SavedSearch.md new file mode 100644 index 000000000..6ad58f531 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SavedSearch.md @@ -0,0 +1,63 @@ +--- +id: saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearch', 'SavedSearch'] +slug: /tools/sdk/python/v3/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch'] +--- + +# SavedSearch + + +## 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] +**id** | **str** | The saved search ID. | [optional] +**owner** | [**TypedReference**](typed-reference) | | [optional] +**owner_id** | **str** | The ID of the identity that owns this saved search. | [optional] +**public** | **bool** | 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. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.saved_search import SavedSearch + +saved_search = SavedSearch( +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=, +id='0de46054-fe90-434a-b84e-c6b3359d0c64', +owner=sailpoint.v3.models.typed_reference.TypedReference( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', ), +owner_id='2c91808568c529c60168cca6f90c1313', +public=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SavedSearchDetail.md b/docs/tools/sdk/python/Reference/V3/Models/SavedSearchDetail.md new file mode 100644 index 000000000..3cab37209 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SavedSearchDetail.md @@ -0,0 +1,49 @@ +--- +id: saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchDetail', 'SavedSearchDetail'] +slug: /tools/sdk/python/v3/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'SavedSearchDetail'] +--- + +# SavedSearchDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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.saved_search_detail import SavedSearchDetail + +saved_search_detail = SavedSearchDetail( +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/SavedSearchDetailFilters.md b/docs/tools/sdk/python/Reference/V3/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..24726d7c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SavedSearchDetailFilters.md @@ -0,0 +1,47 @@ +--- +id: saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchDetailFilters', 'SavedSearchDetailFilters'] +slug: /tools/sdk/python/v3/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'SavedSearchDetailFilters'] +--- + +# SavedSearchDetailFilters + + +## 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.saved_search_detail_filters import SavedSearchDetailFilters + +saved_search_detail_filters = SavedSearchDetailFilters( +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/SavedSearchName.md b/docs/tools/sdk/python/Reference/V3/Models/SavedSearchName.md new file mode 100644 index 000000000..39c10fff0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SavedSearchName.md @@ -0,0 +1,35 @@ +--- +id: saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SavedSearchName', 'SavedSearchName'] +slug: /tools/sdk/python/v3/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'SavedSearchName'] +--- + +# SavedSearchName + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the saved search. | [optional] +**description** | **str** | The description of the saved search. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.saved_search_name import SavedSearchName + +saved_search_name = SavedSearchName( +name='Disabled accounts', +description='Disabled accounts' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Schedule.md b/docs/tools/sdk/python/Reference/V3/Models/Schedule.md new file mode 100644 index 000000000..cad95cad3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Schedule.md @@ -0,0 +1,52 @@ +--- +id: schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule', 'Schedule'] +slug: /tools/sdk/python/v3/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'Schedule'] +--- + +# Schedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WEEKLY', 'MONTHLY', 'ANNUALLY', 'CALENDAR' ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] +**months** | [**ScheduleMonths**](schedule-months) | | [optional] +**days** | [**ScheduleDays**](schedule-days) | | [optional] +**hours** | [**ScheduleHours**](schedule-hours) | | [required] +**expiration** | **datetime** | Specifies the time after which this schedule will no longer occur. | [optional] +**time_zone_id** | **str** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule import Schedule + +schedule = Schedule( +type='WEEKLY', +months=sailpoint.v3.models.schedule_months.Schedule_months( + type = 'LIST', + values = [1], + interval = 2, ), +days=sailpoint.v3.models.schedule_days.Schedule_days( + type = 'LIST', + values = [1], + interval = 2, ), +hours=sailpoint.v3.models.schedule_hours.Schedule_hours( + type = 'LIST', + values = [1], + interval = 2, ), +expiration=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +time_zone_id='CST' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Schedule1.md b/docs/tools/sdk/python/Reference/V3/Models/Schedule1.md new file mode 100644 index 000000000..ae02d9597 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Schedule1.md @@ -0,0 +1,44 @@ +--- +id: schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1', 'Schedule1'] +slug: /tools/sdk/python/v3/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'Schedule1'] +--- + +# Schedule1 + +The schedule information. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ScheduleType**](schedule-type) | | [required] +**months** | [**Schedule1Months**](schedule1-months) | | [optional] +**days** | [**Schedule1Days**](schedule1-days) | | [optional] +**hours** | [**Schedule1Hours**](schedule1-hours) | | [required] +**expiration** | **datetime** | A date-time in ISO-8601 format | [optional] +**time_zone_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule1 import Schedule1 + +schedule1 = Schedule1( +type='WEEKLY', +months=, +days=, +hours=, +expiration='2018-06-25T20:22:28.104Z', +time_zone_id='America/Chicago' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Schedule1Days.md b/docs/tools/sdk/python/Reference/V3/Models/Schedule1Days.md new file mode 100644 index 000000000..4bfc9494f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Schedule1Days.md @@ -0,0 +1,37 @@ +--- +id: schedule1-days +title: Schedule1Days +pagination_label: Schedule1Days +sidebar_label: Schedule1Days +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1Days', 'Schedule1Days'] +slug: /tools/sdk/python/v3/models/schedule1-days +tags: ['SDK', 'Software Development Kit', 'Schedule1Days', 'Schedule1Days'] +--- + +# Schedule1Days + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**SelectorType**](selector-type) | | [required] +**values** | **[]str** | The selected values. | [required] +**interval** | **int** | The selected interval for RANGE selectors. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule1_days import Schedule1Days + +schedule1_days = Schedule1Days( +type='LIST', +values=[MON, WED], +interval=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Schedule1Hours.md b/docs/tools/sdk/python/Reference/V3/Models/Schedule1Hours.md new file mode 100644 index 000000000..913ae14a0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Schedule1Hours.md @@ -0,0 +1,37 @@ +--- +id: schedule1-hours +title: Schedule1Hours +pagination_label: Schedule1Hours +sidebar_label: Schedule1Hours +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1Hours', 'Schedule1Hours'] +slug: /tools/sdk/python/v3/models/schedule1-hours +tags: ['SDK', 'Software Development Kit', 'Schedule1Hours', 'Schedule1Hours'] +--- + +# Schedule1Hours + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**SelectorType**](selector-type) | | [required] +**values** | **[]str** | The selected values. | [required] +**interval** | **int** | The selected interval for RANGE selectors. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule1_hours import Schedule1Hours + +schedule1_hours = Schedule1Hours( +type='LIST', +values=[MON, WED], +interval=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Schedule1Months.md b/docs/tools/sdk/python/Reference/V3/Models/Schedule1Months.md new file mode 100644 index 000000000..417b64b3b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Schedule1Months.md @@ -0,0 +1,37 @@ +--- +id: schedule1-months +title: Schedule1Months +pagination_label: Schedule1Months +sidebar_label: Schedule1Months +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Schedule1Months', 'Schedule1Months'] +slug: /tools/sdk/python/v3/models/schedule1-months +tags: ['SDK', 'Software Development Kit', 'Schedule1Months', 'Schedule1Months'] +--- + +# Schedule1Months + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**SelectorType**](selector-type) | | [required] +**values** | **[]str** | The selected values. | [required] +**interval** | **int** | The selected interval for RANGE selectors. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule1_months import Schedule1Months + +schedule1_months = Schedule1Months( +type='LIST', +values=[MON, WED], +interval=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduleDays.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduleDays.md new file mode 100644 index 000000000..2bb9827c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduleDays.md @@ -0,0 +1,38 @@ +--- +id: schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleDays', 'ScheduleDays'] +slug: /tools/sdk/python/v3/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'ScheduleDays'] +--- + +# ScheduleDays + +Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify days value | [required] +**values** | **[]str** | Values of the days based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule_days import ScheduleDays + +schedule_days = ScheduleDays( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduleHours.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduleHours.md new file mode 100644 index 000000000..be0b209ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduleHours.md @@ -0,0 +1,38 @@ +--- +id: schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleHours', 'ScheduleHours'] +slug: /tools/sdk/python/v3/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'ScheduleHours'] +--- + +# ScheduleHours + +Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify hours value | [required] +**values** | **[]str** | Values of the days based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule_hours import ScheduleHours + +schedule_hours = ScheduleHours( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduleMonths.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduleMonths.md new file mode 100644 index 000000000..089eb4c22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduleMonths.md @@ -0,0 +1,38 @@ +--- +id: schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleMonths', 'ScheduleMonths'] +slug: /tools/sdk/python/v3/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'ScheduleMonths'] +--- + +# ScheduleMonths + +Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'LIST', 'RANGE' ] | Enum type to specify months value | [required] +**values** | **[]str** | Values of the months based on the enum type mentioned above | [required] +**interval** | **int** | Interval between the cert generations | [optional] +} + +## Example + +```python +from sailpoint.v3.models.schedule_months import ScheduleMonths + +schedule_months = ScheduleMonths( +type='LIST', +values=[1], +interval=2 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduleType.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduleType.md new file mode 100644 index 000000000..ed4209603 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduleType.md @@ -0,0 +1,29 @@ +--- +id: schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduleType', 'ScheduleType'] +slug: /tools/sdk/python/v3/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'ScheduleType'] +--- + +# ScheduleType + +Enum representing the currently supported schedule types. Additional values may be added in the future without notice. + +## Enum + +* `DAILY` (value: `'DAILY'`) + +* `WEEKLY` (value: `'WEEKLY'`) + +* `MONTHLY` (value: `'MONTHLY'`) + +* `CALENDAR` (value: `'CALENDAR'`) + +* `ANNUALLY` (value: `'ANNUALLY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduledAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduledAttributes.md new file mode 100644 index 000000000..ff34fc33e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduledAttributes.md @@ -0,0 +1,42 @@ +--- +id: scheduled-attributes +title: ScheduledAttributes +pagination_label: ScheduledAttributes +sidebar_label: ScheduledAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledAttributes', 'ScheduledAttributes'] +slug: /tools/sdk/python/v3/models/scheduled-attributes +tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes', 'ScheduledAttributes'] +--- + +# ScheduledAttributes + +Attributes related to a scheduled trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cron_string** | **str** | A valid CRON expression | [optional] +**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required] +**time_zone** | **str** | Time zone identifier | [optional] +**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional] +**weekly_times** | **[]str** | Scheduled execution times | [optional] +} + +## Example + +```python +from sailpoint.v3.models.scheduled_attributes import ScheduledAttributes + +scheduled_attributes = ScheduledAttributes( +cron_string='0 9 * * 1', +frequency='daily', +time_zone='America/Chicago', +weekly_days=Monday, +weekly_times=Monday +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearch.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearch.md new file mode 100644 index 000000000..5ea4f8cf6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearch.md @@ -0,0 +1,69 @@ +--- +id: scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledSearch', 'ScheduledSearch'] +slug: /tools/sdk/python/v3/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'ScheduledSearch'] +--- + +# ScheduledSearch + + +## 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] +**id** | **str** | The scheduled search ID. | [required][readonly] +**owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | [required] +**owner_id** | **str** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [required][readonly] +} + +## Example + +```python +from sailpoint.v3.models.scheduled_search import ScheduledSearch + +scheduled_search = ScheduledSearch( +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, +id='0de46054-fe90-434a-b84e-c6b3359d0c64', +owner=sailpoint.v3.models.scheduled_search_all_of_owner.ScheduledSearch_allOf_owner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', ), +owner_id='2c9180867624cbd7017642d8c8c81f67' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..6ce7065b7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,36 @@ +--- +id: scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledSearchAllOfOwner', 'ScheduledSearchAllOfOwner'] +slug: /tools/sdk/python/v3/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'ScheduledSearchAllOfOwner'] +--- + +# ScheduledSearchAllOfOwner + +The owner of the scheduled search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [required] +**id** | **str** | The ID of the referenced object | [required] +} + +## Example + +```python +from sailpoint.v3.models.scheduled_search_all_of_owner import ScheduledSearchAllOfOwner + +scheduled_search_all_of_owner = ScheduledSearchAllOfOwner( +type='IDENTITY', +id='2c9180867624cbd7017642d8c8c81f67' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearchName.md b/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearchName.md new file mode 100644 index 000000000..0939a30ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ScheduledSearchName.md @@ -0,0 +1,35 @@ +--- +id: scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ScheduledSearchName', 'ScheduledSearchName'] +slug: /tools/sdk/python/v3/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'ScheduledSearchName'] +--- + +# ScheduledSearchName + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the scheduled search. | [optional] +**description** | **str** | The description of the scheduled search. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.scheduled_search_name import ScheduledSearchName + +scheduled_search_name = ScheduledSearchName( +name='Daily disabled accounts', +description='Daily disabled accounts' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Search.md b/docs/tools/sdk/python/Reference/V3/Models/Search.md new file mode 100644 index 000000000..bf9413510 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Search.md @@ -0,0 +1,82 @@ +--- +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/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] +--- + +# Search + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**query_type** | [**QueryType**](query-type) | | [optional] [default to QueryType.SAILPOINT] +**query_version** | **str** | | [optional] +**query** | [**Query**](query) | | [optional] +**query_dsl** | **object** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**text_query** | [**TextQuery**](text-query) | | [optional] +**type_ahead_query** | [**TypeAheadQuery**](type-ahead-query) | | [optional] +**include_nested** | **bool** | Indicates whether nested objects from returned search results should be included. | [optional] [default to True] +**query_result_filter** | [**QueryResultFilter**](query-result-filter) | | [optional] +**aggregation_type** | [**AggregationType**](aggregation-type) | | [optional] [default to AggregationType.DSL] +**aggregations_version** | **str** | | [optional] +**aggregations_dsl** | **object** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**aggregations** | [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**search_after** | **[]str** | 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\"] | [optional] +**filters** | [**map[string]Filter**](filter) | The filters to be applied for each filtered field name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.search import Search + +search = Search( +indices=[identities], +query_type='SAILPOINT', +query_version=, +query=sailpoint.v3.models.query.Query( + query = 'name:a*', + fields = '[firstName,lastName,email]', + time_zone = 'America/Chicago', + inner_hit = sailpoint.v3.models.inner_hit.InnerHit( + query = 'source.name:\"Active Directory\"', + type = 'access', ), ), +query_dsl={match={name=john.doe}}, +text_query=sailpoint.v3.models.text_query.TextQuery( + terms = [The quick brown fox, 3141592, 7], + fields = [displayName, employeeNumber, roleCount], + match_any = False, + contains = True, ), +type_ahead_query=sailpoint.v3.models.type_ahead_query.TypeAheadQuery( + query = 'Work', + field = 'source.name', + nested_type = 'access', + max_expansions = 10, + size = 100, + sort = 'desc', + sort_by_value = True, ), +include_nested=True, +query_result_filter=sailpoint.v3.models.query_result_filter.QueryResultFilter( + includes = [name, displayName], + excludes = [stacktrace], ), +aggregation_type='DSL', +aggregations_version=, +aggregations_dsl={}, +aggregations=, +sort=[displayName, +id], +search_after=[John Doe, 2c91808375d8e80a0175e1f88a575221], +filters={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SearchAggregationSpecification.md b/docs/tools/sdk/python/Reference/V3/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..8a35921ca --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchAggregationSpecification.md @@ -0,0 +1,55 @@ +--- +id: search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchAggregationSpecification', 'SearchAggregationSpecification'] +slug: /tools/sdk/python/v3/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'SearchAggregationSpecification'] +--- + +# SearchAggregationSpecification + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | [**NestedAggregation**](nested-aggregation) | | [optional] +**metric** | [**MetricAggregation**](metric-aggregation) | | [optional] +**filter** | [**FilterAggregation**](filter-aggregation) | | [optional] +**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional] +**sub_aggregation** | [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.search_aggregation_specification import SearchAggregationSpecification + +search_aggregation_specification = SearchAggregationSpecification( +nested=sailpoint.v3.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), +metric=sailpoint.v3.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), +filter=sailpoint.v3.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + type = 'TERM', + field = 'access.type', + value = 'ENTITLEMENT', ), +bucket=sailpoint.v3.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + type = 'TERMS', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ), +sub_aggregation= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SearchArguments.md b/docs/tools/sdk/python/Reference/V3/Models/SearchArguments.md new file mode 100644 index 000000000..1e6d9ff03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchArguments.md @@ -0,0 +1,43 @@ +--- +id: search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchArguments', 'SearchArguments'] +slug: /tools/sdk/python/v3/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'SearchArguments'] +--- + +# SearchArguments + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schedule_id** | **str** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**owner** | [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**recipients** | [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.search_arguments import SearchArguments + +search_arguments = SearchArguments( +schedule_id='7a724640-0c17-4ce9-a8c3-4a89738459c8', +owner=sailpoint.v3.models.typed_reference.TypedReference( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', ), +recipients=[ + sailpoint.v3.models.typed_reference.TypedReference( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SearchAttributeConfig.md b/docs/tools/sdk/python/Reference/V3/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..73175e2c8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchAttributeConfig', 'SearchAttributeConfig'] +slug: /tools/sdk/python/v3/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'SearchAttributeConfig'] +--- + +# SearchAttributeConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the new attribute | [optional] +**display_name** | **str** | The display name of the new attribute | [optional] +**application_attributes** | **object** | Map of application id and their associated attribute. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig + +search_attribute_config = SearchAttributeConfig( +name='newMailAttribute', +display_name='New Mail Attribute', +application_attributes={2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SearchExportReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..56f15ba30 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchExportReportArguments.md @@ -0,0 +1,40 @@ +--- +id: search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchExportReportArguments', 'SearchExportReportArguments'] +slug: /tools/sdk/python/v3/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'SearchExportReportArguments'] +--- + +# SearchExportReportArguments + +Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**query** | **str** | 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. | [required] +**columns** | **str** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.search_export_report_arguments import SearchExportReportArguments + +search_export_report_arguments = SearchExportReportArguments( +indices=[entitlements], +query='name:a*', +columns='displayName,firstName,lastName,email,created,attributes.cloudLifecycleState', +sort=[displayName, +id] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SearchFilterType.md b/docs/tools/sdk/python/Reference/V3/Models/SearchFilterType.md new file mode 100644 index 000000000..8dc738ce6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchFilterType.md @@ -0,0 +1,21 @@ +--- +id: search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchFilterType', 'SearchFilterType'] +slug: /tools/sdk/python/v3/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'SearchFilterType'] +--- + +# SearchFilterType + +Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. + +## Enum + +* `TERM` (value: `'TERM'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SearchSchedule.md b/docs/tools/sdk/python/Reference/V3/Models/SearchSchedule.md new file mode 100644 index 000000000..5099fe448 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchSchedule.md @@ -0,0 +1,57 @@ +--- +id: search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchSchedule', 'SearchSchedule'] +slug: /tools/sdk/python/v3/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'SearchSchedule'] +--- + +# SearchSchedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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.search_schedule import SearchSchedule + +search_schedule = SearchSchedule( +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/SearchScheduleRecipientsInner.md b/docs/tools/sdk/python/Reference/V3/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..98f9bcfe8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,35 @@ +--- +id: search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SearchScheduleRecipientsInner', 'SearchScheduleRecipientsInner'] +slug: /tools/sdk/python/v3/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'SearchScheduleRecipientsInner'] +--- + +# SearchScheduleRecipientsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [required] +**id** | **str** | The ID of the referenced object | [required] +} + +## Example + +```python +from sailpoint.v3.models.search_schedule_recipients_inner import SearchScheduleRecipientsInner + +search_schedule_recipients_inner = SearchScheduleRecipientsInner( +type='IDENTITY', +id='2c9180867624cbd7017642d8c8c81f67' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SectionDetails.md b/docs/tools/sdk/python/Reference/V3/Models/SectionDetails.md new file mode 100644 index 000000000..63e2c444b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SectionDetails.md @@ -0,0 +1,37 @@ +--- +id: section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SectionDetails', 'SectionDetails'] +slug: /tools/sdk/python/v3/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'SectionDetails'] +--- + +# SectionDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +**label** | **str** | Label of the section | [optional] +**form_items** | **[]object** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] +} + +## Example + +```python +from sailpoint.v3.models.section_details import SectionDetails + +section_details = SectionDetails( +name='Field1', +label='Section 1', +form_items=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Segment.md b/docs/tools/sdk/python/Reference/V3/Models/Segment.md new file mode 100644 index 000000000..b9950e5c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Segment.md @@ -0,0 +1,50 @@ +--- +id: segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Segment', 'Segment'] +slug: /tools/sdk/python/v3/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'Segment'] +--- + +# Segment + + +## 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] +**owner** | [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] +**visibility_criteria** | [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**active** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.segment import Segment + +segment = Segment( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='segment-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This segment represents xyz', +owner=sailpoint.v3.models.owner_reference_segments.OwnerReferenceSegments( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +visibility_criteria=, +active=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..81801f25f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,38 @@ +--- +id: segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SegmentVisibilityCriteria', 'SegmentVisibilityCriteria'] +slug: /tools/sdk/python/v3/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'SegmentVisibilityCriteria'] +--- + +# SegmentVisibilityCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | [**Expression**](expression) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.segment_visibility_criteria import SegmentVisibilityCriteria + +segment_visibility_criteria = SegmentVisibilityCriteria( +expression=sailpoint.v3.models.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/Selector.md b/docs/tools/sdk/python/Reference/V3/Models/Selector.md new file mode 100644 index 000000000..c6aaf99ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Selector.md @@ -0,0 +1,37 @@ +--- +id: selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Selector', 'Selector'] +slug: /tools/sdk/python/v3/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'Selector'] +--- + +# Selector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**SelectorType**](selector-type) | | [required] +**values** | **[]str** | The selected values. | [required] +**interval** | **int** | The selected interval for RANGE selectors. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.selector import Selector + +selector = Selector( +type='LIST', +values=[MON, WED], +interval=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SelectorType.md b/docs/tools/sdk/python/Reference/V3/Models/SelectorType.md new file mode 100644 index 000000000..d22a1f0e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SelectorType.md @@ -0,0 +1,23 @@ +--- +id: selector-type +title: SelectorType +pagination_label: SelectorType +sidebar_label: SelectorType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SelectorType', 'SelectorType'] +slug: /tools/sdk/python/v3/models/selector-type +tags: ['SDK', 'Software Development Kit', 'SelectorType', 'SelectorType'] +--- + +# SelectorType + +Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. + +## Enum + +* `LIST` (value: `'LIST'`) + +* `RANGE` (value: `'RANGE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SendTokenRequest.md b/docs/tools/sdk/python/Reference/V3/Models/SendTokenRequest.md new file mode 100644 index 000000000..5a0806363 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SendTokenRequest.md @@ -0,0 +1,35 @@ +--- +id: send-token-request +title: SendTokenRequest +pagination_label: SendTokenRequest +sidebar_label: SendTokenRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendTokenRequest', 'SendTokenRequest'] +slug: /tools/sdk/python/v3/models/send-token-request +tags: ['SDK', 'Software Development Kit', 'SendTokenRequest', 'SendTokenRequest'] +--- + +# SendTokenRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_alias** | **str** | User alias from table spt_identity field named 'name' | [required] +**delivery_type** | **Enum** [ 'SMS_PERSONAL', 'VOICE_PERSONAL', 'SMS_WORK', 'VOICE_WORK', 'EMAIL_WORK', 'EMAIL_PERSONAL' ] | Token delivery type | [required] +} + +## Example + +```python +from sailpoint.v3.models.send_token_request import SendTokenRequest + +send_token_request = SendTokenRequest( +user_alias='will.albin', +delivery_type='EMAIL_WORK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SendTokenResponse.md b/docs/tools/sdk/python/Reference/V3/Models/SendTokenResponse.md new file mode 100644 index 000000000..4f6fe1d70 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SendTokenResponse.md @@ -0,0 +1,37 @@ +--- +id: send-token-response +title: SendTokenResponse +pagination_label: SendTokenResponse +sidebar_label: SendTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SendTokenResponse', 'SendTokenResponse'] +slug: /tools/sdk/python/v3/models/send-token-response +tags: ['SDK', 'Software Development Kit', 'SendTokenResponse', 'SendTokenResponse'] +--- + +# SendTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The token request ID | [optional] +**status** | **Enum** [ 'SUCCESS', 'FAILED' ] | Status of sending token | [optional] +**error_message** | **str** | Error messages from token send request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.send_token_response import SendTokenResponse + +send_token_response = SendTokenResponse( +request_id='089899f13a8f4da7824996191587bab9', +status='SUCCESS', +error_message='Unable to sent text message' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..35883f7d8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,73 @@ +--- +id: service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationDto', 'ServiceDeskIntegrationDto'] +slug: /tools/sdk/python/v3/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'ServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the Service Desk integration | [optional] +**name** | **str** | Service Desk integration's name. The name must be unique. | [required] +**created** | **datetime** | The date and time the Service Desk integration was created | [optional] +**modified** | **datetime** | The date and time the Service Desk integration was last modified | [optional] +**description** | **str** | Service Desk integration's description. | [required] +**type** | **str** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to 'ServiceNowSDIM'] +**owner_ref** | [**OwnerDto**](owner-dto) | | [optional] +**cluster_ref** | [**SourceClusterDto**](source-cluster-dto) | | [optional] +**cluster** | **str** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**managed_sources** | **[]str** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**provisioning_config** | [**ProvisioningConfig**](provisioning-config) | | [optional] +**attributes** | **map[string]object** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**before_provisioning_rule** | [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto + +service_desk_integration_dto = ServiceDeskIntegrationDto( +id='62945a496ef440189b1f03e3623411c8', +name='Service Desk Integration Name', +created='2024-01-17T18:45:25.994Z', +modified='2024-02-18T18:45:25.994Z', +description='A very nice Service Desk integration', +type='ServiceNowSDIM', +owner_ref=sailpoint.v3.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +cluster_ref=sailpoint.v3.models.source_cluster_dto.SourceClusterDto( + type = 'CLUSTER', + id = '2c9180847a7fccdd017aa5896f9f4f6f', + name = 'Training VA', ), +cluster='xyzzy999', +managed_sources=[2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823], +provisioning_config=sailpoint.v3.models.provisioning_config.ProvisioningConfig( + universal_manager = True, + managed_resource_refs = [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], + plan_initializer_script = sailpoint.v3.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), + no_provisioning_requests = True, + provisioning_request_expiration = 7, ), +attributes={property=value, key=value}, +before_provisioning_rule=sailpoint.v3.models.before_provisioning_rule_dto.BeforeProvisioningRuleDto( + type = 'RULE', + id = '048eb3d55c5a4758bd07dccb87741c78', + name = 'Before Provisioning Airtable Rule', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..ab310ff57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,52 @@ +--- +id: service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/python/v3/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'ServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the Object | [optional] [readonly] +**name** | **str** | Name of the Object | [required] +**created** | **datetime** | Creation date of the Object | [optional] [readonly] +**modified** | **datetime** | Last modification date of the Object | [optional] [readonly] +**type** | **str** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to 'Web Service SDIM'] +**attributes** | **map[string]object** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] +**provisioning_config** | [**ProvisioningConfig**](provisioning-config) | | [required] +} + +## Example + +```python +from sailpoint.v3.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto + +service_desk_integration_template_dto = ServiceDeskIntegrationTemplateDto( +id='id12345', +name='aName', +created='2015-05-28T14:07:17Z', +modified='2015-05-28T14:07:17Z', +type='Web Service SDIM', +attributes={property=value, key=value}, +provisioning_config=sailpoint.v3.models.provisioning_config.ProvisioningConfig( + universal_manager = True, + managed_resource_refs = [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}], + plan_initializer_script = sailpoint.v3.models.provisioning_config_plan_initializer_script.ProvisioningConfig_planInitializerScript( + source = '\r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n +', ), + no_provisioning_requests = True, + provisioning_request_expiration = 7, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..279eecea5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,38 @@ +--- +id: service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskIntegrationTemplateType', 'ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/python/v3/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'ServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +This represents a Service Desk Integration template type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This is the name of the type. | [optional] +**type** | **str** | This is the type value for the type. | [required] +**script_name** | **str** | This is the scriptName attribute value for the type. | [required] +} + +## Example + +```python +from sailpoint.v3.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType + +service_desk_integration_template_type = ServiceDeskIntegrationTemplateType( +name='aName', +type='aType', +script_name='aScriptName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskSource.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskSource.md new file mode 100644 index 000000000..e2c16cd5e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceDeskSource.md @@ -0,0 +1,38 @@ +--- +id: service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceDeskSource', 'ServiceDeskSource'] +slug: /tools/sdk/python/v3/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'ServiceDeskSource'] +--- + +# ServiceDeskSource + +Source for Service Desk integration template. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOURCE' ] | DTO type of source for service desk integration template. | [optional] +**id** | **str** | ID of source for service desk integration template. | [optional] +**name** | **str** | Human-readable name of source for service desk integration template. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.service_desk_source import ServiceDeskSource + +service_desk_source = ServiceDeskSource( +type='SOURCE', +id='2c9180835d191a86015d28455b4b232a', +name='HR Active Directory' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..bb0dafd86 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfiguration.md @@ -0,0 +1,40 @@ +--- +id: service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfiguration', 'ServiceProviderConfiguration'] +slug: /tools/sdk/python/v3/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to False] +**bypass_idp** | **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to False] +**saml_configuration_valid** | **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to False] +**federation_protocol_details** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] +} + +## Example + +```python +from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration + +service_provider_configuration = ServiceProviderConfiguration( +enabled=True, +bypass_idp=True, +saml_configuration_valid=True, +federation_protocol_details=[{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..0b8aa6a09 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,66 @@ +--- +id: service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/python/v3/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ '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] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**auth_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_auth_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner + +service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( +role='SAML_SP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +auth_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_auth_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v3.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SessionConfiguration.md b/docs/tools/sdk/python/Reference/V3/Models/SessionConfiguration.md new file mode 100644 index 000000000..738d62785 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SessionConfiguration.md @@ -0,0 +1,37 @@ +--- +id: session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SessionConfiguration', 'SessionConfiguration'] +slug: /tools/sdk/python/v3/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'SessionConfiguration'] +--- + +# SessionConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_idle_time** | **int** | The maximum time in minutes a session can be idle. | [optional] +**remember_me** | **bool** | Denotes if 'remember me' is enabled. | [optional] [default to False] +**max_session_time** | **int** | The maximum allowable session time in minutes. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.session_configuration import SessionConfiguration + +session_configuration = SessionConfiguration( +max_idle_time=15, +remember_me=True, +max_session_time=45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SetLifecycleState200Response.md b/docs/tools/sdk/python/Reference/V3/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..368028f40 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SetLifecycleState200Response.md @@ -0,0 +1,33 @@ +--- +id: set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetLifecycleState200Response', 'SetLifecycleState200Response'] +slug: /tools/sdk/python/v3/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'SetLifecycleState200Response'] +--- + +# SetLifecycleState200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_activity_id** | **str** | 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. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.set_lifecycle_state200_response import SetLifecycleState200Response + +set_lifecycle_state200_response = SetLifecycleState200Response( +account_activity_id='2c9180837ab5b716017ab7c6c9ef1e20' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/python/Reference/V3/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..e3454d41e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SetLifecycleStateRequest.md @@ -0,0 +1,33 @@ +--- +id: set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SetLifecycleStateRequest', 'SetLifecycleStateRequest'] +slug: /tools/sdk/python/v3/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'SetLifecycleStateRequest'] +--- + +# SetLifecycleStateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lifecycle_state_id** | **str** | ID of the lifecycle state to set. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.set_lifecycle_state_request import SetLifecycleStateRequest + +set_lifecycle_state_request = SetLifecycleStateRequest( +lifecycle_state_id='2c9180877a86e408017a8c19fefe046c' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SlimCampaign.md b/docs/tools/sdk/python/Reference/V3/Models/SlimCampaign.md new file mode 100644 index 000000000..085df14ce --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SlimCampaign.md @@ -0,0 +1,68 @@ +--- +id: slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SlimCampaign', 'SlimCampaign'] +slug: /tools/sdk/python/v3/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'SlimCampaign'] +--- + +# SlimCampaign + + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.slim_campaign import SlimCampaign + +slim_campaign = SlimCampaign( +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.', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/python/Reference/V3/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..18b48154d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SlimDiscoveredApplications.md @@ -0,0 +1,50 @@ +--- +id: slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SlimDiscoveredApplications', 'SlimDiscoveredApplications'] +slug: /tools/sdk/python/v3/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'SlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +Discovered applications + +## 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] +} + +## Example + +```python +from sailpoint.v3.models.slim_discovered_applications import SlimDiscoveredApplications + +slim_discovered_applications = SlimDiscoveredApplications( +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' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodExemptCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SodExemptCriteria.md new file mode 100644 index 000000000..7496fdf1f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodExemptCriteria.md @@ -0,0 +1,40 @@ +--- +id: sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodExemptCriteria', 'SodExemptCriteria'] +slug: /tools/sdk/python/v3/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'SodExemptCriteria'] +--- + +# SodExemptCriteria + +Details of the Entitlement criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**existing** | **bool** | If the entitlement already belonged to the user or not. | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | Entitlement ID | [optional] +**name** | **str** | Entitlement name | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_exempt_criteria import SodExemptCriteria + +sod_exempt_criteria = SodExemptCriteria( +existing=True, +type='IDENTITY', +id='2c918085771e9d3301773b3cb66f6398', +name='My HR Entitlement' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md new file mode 100644 index 000000000..cf8848242 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md @@ -0,0 +1,75 @@ +--- +id: sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicy', 'SodPolicy'] +slug: /tools/sdk/python/v3/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'SodPolicy'] +--- + +# SodPolicy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Policy id | [optional] [readonly] +**name** | **str** | Policy Business Name | [optional] +**created** | **datetime** | The time when this SOD policy is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy is modified. | [optional] [readonly] +**description** | **str** | Optional description of the SOD policy | [optional] +**owner_ref** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**external_policy_reference** | **str** | Optional External Policy Reference | [optional] +**policy_query** | **str** | Search query of the SOD policy | [optional] +**compensating_controls** | **str** | Optional compensating controls(Mitigating Controls) | [optional] +**correction_advice** | **str** | Optional correction advice | [optional] +**state** | **Enum** [ 'ENFORCED', 'NOT_ENFORCED' ] | whether the policy is enforced or not | [optional] +**tags** | **[]str** | tags for this policy object | [optional] +**creator_id** | **str** | Policy's creator ID | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID | [optional] [readonly] +**violation_owner_assignment_config** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**scheduled** | **bool** | defines whether a policy has been scheduled or not | [optional] [default to False] +**type** | **Enum** [ 'GENERAL', 'CONFLICTING_ACCESS_BASED' ] | whether a policy is query based or conflicting access based | [optional] [default to 'GENERAL'] +**conflicting_access_criteria** | [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy import SodPolicy + +sod_policy = SodPolicy( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='policy-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This policy ensures compliance of xyz', +owner_ref=sailpoint.v3.models.sod_policy_owner_ref.SodPolicy_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +external_policy_reference='XYZ policy', +policy_query='@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)', +compensating_controls='Have a manager review the transaction decisions for their "out of compliance" employee', +correction_advice='Based on the role of the employee, managers should remove access that is not required for their job function.', +state='ENFORCED', +tags=[TAG1, TAG2], +creator_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +modifier_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +violation_owner_assignment_config=sailpoint.v3.models.violation_owner_assignment_config.ViolationOwnerAssignmentConfig( + assignment_rule = 'MANAGER', + owner_ref = sailpoint.v3.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), ), +scheduled=True, +type='GENERAL', +conflicting_access_criteria= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..32a10ed8d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/python/v3/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +**right_criteria** | [**AccessCriteria**](access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_conflicting_access_criteria import SodPolicyConflictingAccessCriteria + +sod_policy_conflicting_access_criteria = SodPolicyConflictingAccessCriteria( +left_criteria=sailpoint.v3.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.v3.models.access_criteria.AccessCriteria( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyDto.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyDto.md new file mode 100644 index 000000000..b925f2f0a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyDto.md @@ -0,0 +1,38 @@ +--- +id: sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyDto', 'SodPolicyDto'] +slug: /tools/sdk/python/v3/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'SodPolicyDto'] +--- + +# SodPolicyDto + +SOD policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'SOD_POLICY' ] | SOD policy DTO type. | [optional] +**id** | **str** | SOD policy ID. | [optional] +**name** | **str** | SOD policy display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_dto import SodPolicyDto + +sod_policy_dto = SodPolicyDto( +type='SOD_POLICY', +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='Business SOD Policy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..067211f53 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyOwnerRef.md @@ -0,0 +1,38 @@ +--- +id: sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyOwnerRef', 'SodPolicyOwnerRef'] +slug: /tools/sdk/python/v3/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'SodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +The owner of the SOD policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | Owner type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_owner_ref import SodPolicyOwnerRef + +sod_policy_owner_ref = SodPolicyOwnerRef( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicySchedule.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicySchedule.md new file mode 100644 index 000000000..21a869ff3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicySchedule.md @@ -0,0 +1,60 @@ +--- +id: sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicySchedule', 'SodPolicySchedule'] +slug: /tools/sdk/python/v3/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'SodPolicySchedule'] +--- + +# SodPolicySchedule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | SOD Policy schedule name | [optional] +**created** | **datetime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**description** | **str** | SOD Policy schedule description | [optional] +**schedule** | [**Schedule1**](schedule1) | | [optional] +**recipients** | [**[]SodRecipient**](sod-recipient) | | [optional] +**email_empty_results** | **bool** | Indicates if empty results need to be emailed | [optional] [default to False] +**creator_id** | **str** | Policy's creator ID | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + +sod_policy_schedule = SodPolicySchedule( +name='SCH-1584312283015', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='Schedule for policy xyz', +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.sod_recipient.SodRecipient( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ) + ], +email_empty_results=False, +creator_id='0f11f2a47c944bf3a2bd742580fe3bde', +modifier_id='0f11f2a47c944bf3a2bd742580fe3bde' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodRecipient.md b/docs/tools/sdk/python/Reference/V3/Models/SodRecipient.md new file mode 100644 index 000000000..19d200144 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodRecipient.md @@ -0,0 +1,38 @@ +--- +id: sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodRecipient', 'SodRecipient'] +slug: /tools/sdk/python/v3/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'SodRecipient'] +--- + +# SodRecipient + +SOD policy recipient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | SOD policy recipient DTO type. | [optional] +**id** | **str** | SOD policy recipient's identity ID. | [optional] +**name** | **str** | SOD policy recipient's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_recipient import SodRecipient + +sod_recipient = SodRecipient( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodReportResultDto.md b/docs/tools/sdk/python/Reference/V3/Models/SodReportResultDto.md new file mode 100644 index 000000000..10c528f33 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodReportResultDto.md @@ -0,0 +1,38 @@ +--- +id: sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodReportResultDto', 'SodReportResultDto'] +slug: /tools/sdk/python/v3/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'SodReportResultDto'] +--- + +# SodReportResultDto + +SOD policy violation report result. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'REPORT_RESULT' ] | SOD policy violation report result DTO type. | [optional] +**id** | **str** | SOD policy violation report result ID. | [optional] +**name** | **str** | Human-readable name of the SOD policy violation report result. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_report_result_dto import SodReportResultDto + +sod_report_result_dto = SodReportResultDto( +type='REPORT_RESULT', +id='2c9180835d191a86015d28455b4b232a', +name='SOD Policy 1 Violation' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodViolationCheck.md b/docs/tools/sdk/python/Reference/V3/Models/SodViolationCheck.md new file mode 100644 index 000000000..39fc919df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodViolationCheck.md @@ -0,0 +1,36 @@ +--- +id: sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationCheck', 'SodViolationCheck'] +slug: /tools/sdk/python/v3/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'SodViolationCheck'] +--- + +# SodViolationCheck + +An object referencing an SOD violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The id of the original request | [required] +**created** | **datetime** | The date-time when this request was created. | [optional] [readonly] +} + +## Example + +```python +from sailpoint.v3.models.sod_violation_check import SodViolationCheck + +sod_violation_check = SodViolationCheck( +request_id='089899f13a8f4da7824996191587bab9', +created='2020-01-01T00:00Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodViolationCheckResult.md b/docs/tools/sdk/python/Reference/V3/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..4f924cceb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodViolationCheckResult.md @@ -0,0 +1,64 @@ +--- +id: sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationCheckResult', 'SodViolationCheckResult'] +slug: /tools/sdk/python/v3/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'SodViolationCheckResult'] +--- + +# SodViolationCheckResult + +The inner object representing the completed SOD Violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | [**ErrorMessageDto**](error-message-dto) | | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**violation_contexts** | [**[]SodViolationContext**](sod-violation-context) | | [optional] +**violated_policies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_violation_check_result import SodViolationCheckResult + +sod_violation_check_result = SodViolationCheckResult( +message=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.', ), +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +violation_contexts=[ + sailpoint.v3.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], +violated_policies=[ + sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodViolationContext.md b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContext.md new file mode 100644 index 000000000..9b6c92a3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContext.md @@ -0,0 +1,48 @@ +--- +id: sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContext', 'SodViolationContext'] +slug: /tools/sdk/python/v3/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'SodViolationContext'] +--- + +# SodViolationContext + +The contextual information of the violated criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**SodPolicyDto**](sod-policy-dto) | | [optional] +**conflicting_access_criteria** | [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_violation_context import SodViolationContext + +sod_violation_context = SodViolationContext( +policy=sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), +conflicting_access_criteria=sailpoint.v3.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..7a37e3923 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,65 @@ +--- +id: sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextCheckCompleted', 'SodViolationContextCheckCompleted'] +slug: /tools/sdk/python/v3/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'SodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +An object referencing a completed SOD violation check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional] +**uuid** | **str** | The id of the Violation check event | [optional] +**violation_check_result** | [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_violation_context_check_completed import SodViolationContextCheckCompleted + +sod_violation_context_check_completed = SodViolationContextCheckCompleted( +state='SUCCESS', +uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd', +violation_check_result=sailpoint.v3.models.sod_violation_check_result.SodViolationCheckResult( + message = 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.', ), + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + violation_contexts = [ + sailpoint.v3.models.sod_violation_context.SodViolationContext( + policy = sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + type = 'SOD_POLICY', + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ), + conflicting_access_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria.SodViolationContext_conflictingAccessCriteria( + left_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), + right_criteria = sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria(), ), ) + ], + violated_policies = [ + sailpoint.v3.models.sod_policy_dto.SodPolicyDto( + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', + name = 'Business SOD Policy', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..3376637a5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,50 @@ +--- +id: sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/python/v3/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'SodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**right_criteria** | [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_violation_context_conflicting_access_criteria import SodViolationContextConflictingAccessCriteria + +sod_violation_context_conflicting_access_criteria = SodViolationContextConflictingAccessCriteria( +left_criteria=sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ), +right_criteria=sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria.SodViolationContext_conflictingAccessCriteria_leftCriteria( + criteria_list = [ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..3b1e1c19c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,39 @@ +--- +id: sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/python/v3/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteria_list** | [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_violation_context_conflicting_access_criteria_left_criteria import SodViolationContextConflictingAccessCriteriaLeftCriteria + +sod_violation_context_conflicting_access_criteria_left_criteria = SodViolationContextConflictingAccessCriteriaLeftCriteria( +criteria_list=[ + sailpoint.v3.models.sod_exempt_criteria.SodExemptCriteria( + existing = True, + type = 'IDENTITY', + id = '2c918085771e9d3301773b3cb66f6398', + name = 'My HR Entitlement', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Source.md b/docs/tools/sdk/python/Reference/V3/Models/Source.md new file mode 100644 index 000000000..12f82cadf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Source.md @@ -0,0 +1,114 @@ +--- +id: source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Source', 'Source'] +slug: /tools/sdk/python/v3/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'Source'] +--- + +# Source + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Source ID. | [optional] [readonly] +**name** | **str** | Source's human-readable name. | [required] +**description** | **str** | Source's human-readable description. | [optional] +**owner** | [**SourceOwner**](source-owner) | | [required] +**cluster** | [**SourceCluster**](source-cluster) | | [optional] +**account_correlation_config** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**account_correlation_rule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**manager_correlation_mapping** | [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**manager_correlation_rule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**before_provisioning_rule** | [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**password_policies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**features** | **[]str** | 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. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**type** | **str** | 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`. | [optional] +**connector** | **str** | Connector script name. | [required] +**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**connector_attributes** | **object** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False] +**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**since** | **str** | Timestamp that shows when a source health check was last performed. | [optional] +**connector_id** | **str** | Connector ID | [optional] +**connector_name** | **str** | Name of the connector that was chosen during source creation. | [optional] +**connection_type** | **str** | Type of connection (direct or file). | [optional] +**connector_implementation_id** | **str** | Connector implementation ID. | [optional] +**created** | **datetime** | Date-time when the source was created | [optional] +**modified** | **datetime** | Date-time when the source was last modified. | [optional] +**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False] +**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source import Source + +source = Source( +id='2c91808568c529c60168cca6f90c1324', +name='My Source', +description='This is the corporate directory.', +owner=sailpoint.v3.models.source_owner.Source_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'MyName', ), +cluster=sailpoint.v3.models.source_cluster.Source_cluster( + type = 'CLUSTER', + id = '2c9180866166b5b0016167c32ef31a66', + name = 'Corporate Cluster', ), +account_correlation_config=sailpoint.v3.models.source_account_correlation_config.Source_accountCorrelationConfig( + type = 'ACCOUNT_CORRELATION_CONFIG', + id = '2c9180855d191c59015d28583727245a', + name = 'Directory [source-62867] Account Correlation', ), +account_correlation_rule=sailpoint.v3.models.source_account_correlation_rule.Source_accountCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +manager_correlation_mapping=, +manager_correlation_rule=sailpoint.v3.models.source_manager_correlation_rule.Source_managerCorrelationRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +before_provisioning_rule=sailpoint.v3.models.source_before_provisioning_rule.Source_beforeProvisioningRule( + type = 'RULE', + id = '2c918085708c274401708c2a8a760001', + name = 'Example Rule', ), +schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}], +password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}], +features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS], +type='OpenLDAP - Direct', +connector='active-directory', +connector_class='sailpoint.connector.LDAPConnector', +connector_attributes={healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]}, +delete_threshold=10, +authoritative=False, +management_workgroup=sailpoint.v3.models.source_management_workgroup.Source_managementWorkgroup( + type = 'GOVERNANCE_GROUP', + id = '2c91808568c529c60168cca6f90c2222', + name = 'My Management Workgroup', ), +healthy=True, +status='SOURCE_STATE_HEALTHY', +since='2021-09-28T15:48:29.3801666300Z', +connector_id='active-directory', +connector_name='Active Directory', +connection_type='file', +connector_implementation_id='delimited-file', +created='2022-02-08T14:50:03.827Z', +modified='2024-01-23T18:08:50.897Z', +credential_provider_enabled=False, +category='CredentialProvider' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/python/Reference/V3/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..b8db2e39c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,38 @@ +--- +id: source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountCorrelationConfig', 'SourceAccountCorrelationConfig'] +slug: /tools/sdk/python/v3/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'SourceAccountCorrelationConfig'] +--- + +# SourceAccountCorrelationConfig + +Reference to account correlation config object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCOUNT_CORRELATION_CONFIG' ] | Type of object being referenced. | [optional] +**id** | **str** | Account correlation config ID. | [optional] +**name** | **str** | Account correlation config's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_account_correlation_config import SourceAccountCorrelationConfig + +source_account_correlation_config = SourceAccountCorrelationConfig( +type='ACCOUNT_CORRELATION_CONFIG', +id='2c9180855d191c59015d28583727245a', +name='Directory [source-62867] Account Correlation' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/python/Reference/V3/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..85e6b4e38 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,38 @@ +--- +id: source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountCorrelationRule', 'SourceAccountCorrelationRule'] +slug: /tools/sdk/python/v3/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'SourceAccountCorrelationRule'] +--- + +# SourceAccountCorrelationRule + +Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_account_correlation_rule import SourceAccountCorrelationRule + +source_account_correlation_rule = SourceAccountCorrelationRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/python/Reference/V3/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..75be785dc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,38 @@ +--- +id: source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceBeforeProvisioningRule', 'SourceBeforeProvisioningRule'] +slug: /tools/sdk/python/v3/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'SourceBeforeProvisioningRule'] +--- + +# SourceBeforeProvisioningRule + +Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_before_provisioning_rule import SourceBeforeProvisioningRule + +source_before_provisioning_rule = SourceBeforeProvisioningRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceCluster.md b/docs/tools/sdk/python/Reference/V3/Models/SourceCluster.md new file mode 100644 index 000000000..87d4e7a44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceCluster.md @@ -0,0 +1,38 @@ +--- +id: source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceCluster', 'SourceCluster'] +slug: /tools/sdk/python/v3/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'SourceCluster'] +--- + +# SourceCluster + +Reference to the source's associated cluster. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CLUSTER' ] | Type of object being referenced. | [required] +**id** | **str** | Cluster ID. | [required] +**name** | **str** | Cluster's human-readable display name. | [required] +} + +## Example + +```python +from sailpoint.v3.models.source_cluster import SourceCluster + +source_cluster = SourceCluster( +type='CLUSTER', +id='2c9180866166b5b0016167c32ef31a66', +name='Corporate Cluster' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceClusterDto.md b/docs/tools/sdk/python/Reference/V3/Models/SourceClusterDto.md new file mode 100644 index 000000000..865e20b7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceClusterDto.md @@ -0,0 +1,38 @@ +--- +id: source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceClusterDto', 'SourceClusterDto'] +slug: /tools/sdk/python/v3/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'SourceClusterDto'] +--- + +# SourceClusterDto + +Source cluster. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CLUSTER' ] | Source cluster DTO type. | [optional] +**id** | **str** | Source cluster ID. | [optional] +**name** | **str** | Source cluster display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_cluster_dto import SourceClusterDto + +source_cluster_dto = SourceClusterDto( +type='CLUSTER', +id='2c9180847a7fccdd017aa5896f9f4f6f', +name='Training VA' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceConnectionsDto.md b/docs/tools/sdk/python/Reference/V3/Models/SourceConnectionsDto.md new file mode 100644 index 000000000..af886626b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceConnectionsDto.md @@ -0,0 +1,86 @@ +--- +id: source-connections-dto +title: SourceConnectionsDto +pagination_label: SourceConnectionsDto +sidebar_label: SourceConnectionsDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceConnectionsDto', 'SourceConnectionsDto'] +slug: /tools/sdk/python/v3/models/source-connections-dto +tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'SourceConnectionsDto'] +--- + +# SourceConnectionsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_profiles** | [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional] +**credential_profiles** | **[]str** | Name of the CredentialProfile attached to this source | [optional] +**source_attributes** | **[]str** | The attributes attached to this source | [optional] +**mapping_profiles** | **[]str** | The profiles attached to this source | [optional] +**dependent_custom_transforms** | [**[]Transform**](transform) | | [optional] +**dependent_apps** | [**[]DependantAppConnections**](dependant-app-connections) | | [optional] +**missing_dependents** | [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_connections_dto import SourceConnectionsDto + +source_connections_dto = SourceConnectionsDto( +identity_profiles=[ + sailpoint.v3.models.identity_profiles_connections.IdentityProfilesConnections( + id = '76cfddb62818416f816bc494410f46c4', + name = 'ODS-Identity-Profile', + identity_count = 100, ) + ], +credential_profiles=[ + '[Profile ODS]' + ], +source_attributes=[ + '[sAMAccountName, mail, sn, givenName, displayName, employeeNumber, manager, telephoneNumber]' + ], +mapping_profiles=[ODS-AD-Profile, ODS-Profile2], +dependent_custom_transforms=[ + sailpoint.v3.models.transform.Transform( + name = 'Timestamp To Date', + type = 'dateFormat', + attributes = sailpoint.v3.models.attributes.attributes(), ) + ], +dependent_apps=[ + sailpoint.v3.models.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, ) + ], +missing_dependents=[ + sailpoint.v3.models.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/SourceHealthDto.md b/docs/tools/sdk/python/Reference/V3/Models/SourceHealthDto.md new file mode 100644 index 000000000..3ced6c778 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceHealthDto.md @@ -0,0 +1,52 @@ +--- +id: source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceHealthDto', 'SourceHealthDto'] +slug: /tools/sdk/python/v3/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'SourceHealthDto'] +--- + +# SourceHealthDto + +Dto for source health data + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | the id of the Source | [optional] [readonly] +**type** | **str** | 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`. | [optional] +**name** | **str** | the name of the source | [optional] +**org** | **str** | source's org | [optional] +**is_authoritative** | **bool** | Is the source authoritative | [optional] +**is_cluster** | **bool** | Is the source in a cluster | [optional] +**hostname** | **str** | source's hostname | [optional] +**pod** | **str** | source's pod | [optional] +**iq_service_version** | **str** | The version of the iqService | [optional] +**status** | **Enum** [ 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | connection test result | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_health_dto import SourceHealthDto + +source_health_dto = SourceHealthDto( +id='2c91808568c529c60168cca6f90c1324', +type='OpenLDAP - Direct', +name='Source1234', +org='denali-cjh', +is_authoritative=False, +is_cluster=False, +hostname='megapod-useast1-secret-hostname.sailpoint.com', +pod='megapod-useast1', +iq_service_version='iqVersion123', +status='SOURCE_STATE_UNCHECKED_SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/python/Reference/V3/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..8e1a96fd1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceManagementWorkgroup.md @@ -0,0 +1,38 @@ +--- +id: source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceManagementWorkgroup', 'SourceManagementWorkgroup'] +slug: /tools/sdk/python/v3/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'SourceManagementWorkgroup'] +--- + +# SourceManagementWorkgroup + +Reference to management workgroup for the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'GOVERNANCE_GROUP' ] | Type of object being referenced. | [optional] +**id** | **str** | Management workgroup ID. | [optional] +**name** | **str** | Management workgroup's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_management_workgroup import SourceManagementWorkgroup + +source_management_workgroup = SourceManagementWorkgroup( +type='GOVERNANCE_GROUP', +id='2c91808568c529c60168cca6f90c2222', +name='My Management Workgroup' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/python/Reference/V3/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..051c45ae4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,35 @@ +--- +id: source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceManagerCorrelationMapping', 'SourceManagerCorrelationMapping'] +slug: /tools/sdk/python/v3/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'SourceManagerCorrelationMapping'] +--- + +# SourceManagerCorrelationMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_attribute_name** | **str** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**identity_attribute_name** | **str** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_manager_correlation_mapping import SourceManagerCorrelationMapping + +source_manager_correlation_mapping = SourceManagerCorrelationMapping( +account_attribute_name='manager', +identity_attribute_name='manager' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/python/Reference/V3/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..d78cf1aa6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,38 @@ +--- +id: source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceManagerCorrelationRule', 'SourceManagerCorrelationRule'] +slug: /tools/sdk/python/v3/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'SourceManagerCorrelationRule'] +--- + +# SourceManagerCorrelationRule + +Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional] +**id** | **str** | Rule ID. | [optional] +**name** | **str** | Rule's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_manager_correlation_rule import SourceManagerCorrelationRule + +source_manager_correlation_rule = SourceManagerCorrelationRule( +type='RULE', +id='2c918085708c274401708c2a8a760001', +name='Example Rule' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceOwner.md b/docs/tools/sdk/python/Reference/V3/Models/SourceOwner.md new file mode 100644 index 000000000..b629f8833 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceOwner.md @@ -0,0 +1,38 @@ +--- +id: source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceOwner', 'SourceOwner'] +slug: /tools/sdk/python/v3/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'SourceOwner'] +--- + +# SourceOwner + +Reference to identity object who owns the source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Type of object being referenced. | [optional] +**id** | **str** | Owner identity's ID. | [optional] +**name** | **str** | Owner identity's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_owner import SourceOwner + +source_owner = SourceOwner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='MyName' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/python/Reference/V3/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..3cbf47047 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,37 @@ +--- +id: source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourcePasswordPoliciesInner', 'SourcePasswordPoliciesInner'] +slug: /tools/sdk/python/v3/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'SourcePasswordPoliciesInner'] +--- + +# SourcePasswordPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'PASSWORD_POLICY' ] | Type of object being referenced. | [optional] +**id** | **str** | Policy ID. | [optional] +**name** | **str** | Policy's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_password_policies_inner import SourcePasswordPoliciesInner + +source_password_policies_inner = SourcePasswordPoliciesInner( +type='PASSWORD_POLICY', +id='2c91808568c529c60168cca6f90c1777', +name='My Password Policy' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceSchemasInner.md b/docs/tools/sdk/python/Reference/V3/Models/SourceSchemasInner.md new file mode 100644 index 000000000..4748ba23f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceSchemasInner.md @@ -0,0 +1,37 @@ +--- +id: source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceSchemasInner', 'SourceSchemasInner'] +slug: /tools/sdk/python/v3/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'SourceSchemasInner'] +--- + +# SourceSchemasInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'CONNECTOR_SCHEMA' ] | Type of object being referenced. | [optional] +**id** | **str** | Schema ID. | [optional] +**name** | **str** | Schema's human-readable display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_schemas_inner import SourceSchemasInner + +source_schemas_inner = SourceSchemasInner( +type='CONNECTOR_SCHEMA', +id='2c91808568c529c60168cca6f90c1777', +name='MySchema' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md new file mode 100644 index 000000000..159a7ebe0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md @@ -0,0 +1,35 @@ +--- +id: source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUsage', 'SourceUsage'] +slug: /tools/sdk/python/v3/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'SourceUsage'] +--- + +# SourceUsage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional] +**count** | **float** | The average number of days that accounts were active within this source, for the month. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_usage import SourceUsage + +source_usage = SourceUsage( +var_date='Thu Apr 20 20:00:00 EDT 2023', +count=10.45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceUsageStatus.md b/docs/tools/sdk/python/Reference/V3/Models/SourceUsageStatus.md new file mode 100644 index 000000000..7540d0b34 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceUsageStatus.md @@ -0,0 +1,33 @@ +--- +id: source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceUsageStatus', 'SourceUsageStatus'] +slug: /tools/sdk/python/v3/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'SourceUsageStatus'] +--- + +# SourceUsageStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'COMPLETE', 'INCOMPLETE' ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_usage_status import SourceUsageStatus + +source_usage_status = SourceUsageStatus( +status='COMPLETE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SpConfigMessage.md b/docs/tools/sdk/python/Reference/V3/Models/SpConfigMessage.md new file mode 100644 index 000000000..53de08d80 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SpConfigMessage.md @@ -0,0 +1,38 @@ +--- +id: sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpConfigMessage', 'SpConfigMessage'] +slug: /tools/sdk/python/v3/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'SpConfigMessage'] +--- + +# SpConfigMessage + +Message model for Config Import/Export. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Message key. | [required] +**text** | **str** | Message text. | [required] +**details** | **map[string]object** | Message details if any, in key:value pairs. | [required] +} + +## Example + +```python +from sailpoint.v3.models.sp_config_message import SpConfigMessage + +sp_config_message = SpConfigMessage( +key='UNKNOWN_REFERENCE_RESOLVER', +text='Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]', +details={details=message details} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md new file mode 100644 index 000000000..4166ee782 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md @@ -0,0 +1,39 @@ +--- +id: sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpDetails', 'SpDetails'] +slug: /tools/sdk/python/v3/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] +--- + +# SpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ '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] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sp_details import SpDetails + +sp_details = SpDetails( +role='SAML_SP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/StandardLevel.md b/docs/tools/sdk/python/Reference/V3/Models/StandardLevel.md new file mode 100644 index 000000000..bca330410 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/StandardLevel.md @@ -0,0 +1,33 @@ +--- +id: standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'StandardLevel', 'StandardLevel'] +slug: /tools/sdk/python/v3/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'StandardLevel'] +--- + +# StandardLevel + +Standard Log4j log level + +## Enum + +* `FALSE` (value: `'false'`) + +* `FATAL` (value: `'FATAL'`) + +* `ERROR` (value: `'ERROR'`) + +* `WARN` (value: `'WARN'`) + +* `INFO` (value: `'INFO'`) + +* `DEBUG` (value: `'DEBUG'`) + +* `TRACE` (value: `'TRACE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/python/Reference/V3/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..5dbbba8d3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,71 @@ +--- +id: sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SubSearchAggregationSpecification', 'SubSearchAggregationSpecification'] +slug: /tools/sdk/python/v3/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'SubSearchAggregationSpecification'] +--- + +# SubSearchAggregationSpecification + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | [**NestedAggregation**](nested-aggregation) | | [optional] +**metric** | [**MetricAggregation**](metric-aggregation) | | [optional] +**filter** | [**FilterAggregation**](filter-aggregation) | | [optional] +**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional] +**sub_aggregation** | [**Aggregations**](aggregations) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sub_search_aggregation_specification import SubSearchAggregationSpecification + +sub_search_aggregation_specification = SubSearchAggregationSpecification( +nested=sailpoint.v3.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), +metric=sailpoint.v3.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), +filter=sailpoint.v3.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + type = 'TERM', + field = 'access.type', + value = 'ENTITLEMENT', ), +bucket=sailpoint.v3.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + type = 'TERMS', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ), +sub_aggregation=sailpoint.v3.models.aggregations.Aggregations( + nested = sailpoint.v3.models.nested_aggregation.NestedAggregation( + name = 'id', + type = 'access', ), + metric = sailpoint.v3.models.metric_aggregation.MetricAggregation( + name = 'Access Name Count', + type = 'UNIQUE_COUNT', + field = '@access.name', ), + filter = sailpoint.v3.models.filter_aggregation.FilterAggregation( + name = 'Entitlements', + field = 'access.type', + value = 'ENTITLEMENT', ), + bucket = sailpoint.v3.models.bucket_aggregation.BucketAggregation( + name = 'Identity Locations', + field = 'attributes.city', + size = 100, + min_doc_count = 2, ), ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaggedObject.md b/docs/tools/sdk/python/Reference/V3/Models/TaggedObject.md new file mode 100644 index 000000000..d0bee9ffc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaggedObject.md @@ -0,0 +1,39 @@ +--- +id: tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObject', 'TaggedObject'] +slug: /tools/sdk/python/v3/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'TaggedObject'] +--- + +# TaggedObject + +Tagged object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_ref** | [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**tags** | **[]str** | Labels to be applied to an Object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.tagged_object import TaggedObject + +tagged_object = TaggedObject( +object_ref=sailpoint.v3.models.tagged_object_dto.TaggedObjectDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +tags=[BU_FINANCE, PCI] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaggedObjectDto.md b/docs/tools/sdk/python/Reference/V3/Models/TaggedObjectDto.md new file mode 100644 index 000000000..87cbb736d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaggedObjectDto.md @@ -0,0 +1,37 @@ +--- +id: tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaggedObjectDto', 'TaggedObjectDto'] +slug: /tools/sdk/python/v3/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'TaggedObjectDto'] +--- + +# TaggedObjectDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'APPLICATION', 'CAMPAIGN', 'ENTITLEMENT', 'IDENTITY', 'ROLE', 'SOD_POLICY', 'SOURCE' ] | DTO type | [optional] +**id** | **str** | ID of the object this reference applies to | [optional] +**name** | **str** | Human-readable display name of the object this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.v3.models.tagged_object_dto import TaggedObjectDto + +tagged_object_dto = TaggedObjectDto( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetails.md b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetails.md new file mode 100644 index 000000000..45cdcdcc7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetails.md @@ -0,0 +1,60 @@ +--- +id: task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDetails', 'TaskResultDetails'] +slug: /tools/sdk/python/v3/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'TaskResultDetails'] +--- + +# TaskResultDetails + +Details about job or task type, state and lifecycle. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'QUARTZ', 'QPOC', 'MENTOS', 'QUEUED_TASK' ] | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**id** | **str** | Unique task definition identifier. | [optional] +**report_type** | **Enum** [ 'ACCOUNTS', 'IDENTITIES_DETAILS', 'IDENTITIES', 'IDENTITY_PROFILE_IDENTITY_ERROR', 'ORPHAN_IDENTITIES', 'SEARCH_EXPORT', 'UNCORRELATED_ACCOUNTS' ] | Use this property to define what report should be processed in the RDE service. | [optional] +**description** | **str** | Description of the report purpose and/or contents. | [optional] +**parent_name** | **str** | Name of the parent task/report if exists. | [optional] +**launcher** | **str** | Name of the report processing initiator. | [optional] +**created** | **datetime** | Report creation date | [optional] +**launched** | **datetime** | Report start date | [optional] +**completed** | **datetime** | Report completion date | [optional] +**completion_status** | **Enum** [ 'SUCCESS', 'WARNING', 'ERROR', 'TERMINATED', 'TEMP_ERROR' ] | Report completion status. | [optional] +**messages** | [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**returns** | [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**attributes** | **map[string]object** | Extra attributes map(dictionary) needed for the report. | [optional] +**progress** | **str** | Current report state. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.task_result_details import TaskResultDetails + +task_result_details = TaskResultDetails( +type='MENTOS', +id='a248c16fe22222b2bd49615481311111', +report_type=IDENTITIES_DETAILS, +description='A detailed view of the identities in the system.', +parent_name='Audit Report', +launcher='cloudadmin', +created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success', +messages=[], +returns=[], +attributes={org=an-org}, +progress='Initializing...' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..a4e92260e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,41 @@ +--- +id: task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDetailsMessagesInner', 'TaskResultDetailsMessagesInner'] +slug: /tools/sdk/python/v3/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'TaskResultDetailsMessagesInner'] +--- + +# TaskResultDetailsMessagesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'INFO', 'WARN', 'ERROR' ] | Type of the message. | [optional] +**error** | **bool** | Flag whether message is an error. | [optional] [default to False] +**warning** | **bool** | Flag whether message is a warning. | [optional] [default to False] +**key** | **str** | Message string identifier. | [optional] +**localized_text** | **str** | Message context with the locale based language. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.task_result_details_messages_inner import TaskResultDetailsMessagesInner + +task_result_details_messages_inner = TaskResultDetailsMessagesInner( +type='WARN', +error=False, +warning=True, +key='The following account(s) failed to correlate: A,B,C', +localized_text='The following account(s) failed to correlate: A,B,C' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..be770b7d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,35 @@ +--- +id: task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDetailsReturnsInner', 'TaskResultDetailsReturnsInner'] +slug: /tools/sdk/python/v3/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'TaskResultDetailsReturnsInner'] +--- + +# TaskResultDetailsReturnsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_label** | **str** | Attribute description. | [optional] +**attribute_name** | **str** | System or database attribute name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.task_result_details_returns_inner import TaskResultDetailsReturnsInner + +task_result_details_returns_inner = TaskResultDetailsReturnsInner( +display_label=' ', +attribute_name=' ' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaskResultDto.md b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDto.md new file mode 100644 index 000000000..5207a14e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaskResultDto.md @@ -0,0 +1,38 @@ +--- +id: task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultDto', 'TaskResultDto'] +slug: /tools/sdk/python/v3/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'TaskResultDto'] +--- + +# TaskResultDto + +Task result. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'TASK_RESULT' ] | Task result DTO type. | [optional] +**id** | **str** | Task result ID. | [optional] +**name** | **str** | Task result display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.task_result_dto import TaskResultDto + +task_result_dto = TaskResultDto( +type='TASK_RESULT', +id='464ae7bf791e49fdb74606a2e4a89635', +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TaskResultSimplified.md b/docs/tools/sdk/python/Reference/V3/Models/TaskResultSimplified.md new file mode 100644 index 000000000..1e5eb9aa8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TaskResultSimplified.md @@ -0,0 +1,45 @@ +--- +id: task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TaskResultSimplified', 'TaskResultSimplified'] +slug: /tools/sdk/python/v3/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'TaskResultSimplified'] +--- + +# TaskResultSimplified + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Task identifier | [optional] +**name** | **str** | Task name | [optional] +**description** | **str** | Task description | [optional] +**launcher** | **str** | User or process who launched the task | [optional] +**completed** | **datetime** | Date time of completion | [optional] +**launched** | **datetime** | Date time when the task was launched | [optional] +**completion_status** | **Enum** [ 'Success', 'Warning', 'Error', 'Terminated', 'TempError' ] | Task result status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.task_result_simplified import TaskResultSimplified + +task_result_simplified = TaskResultSimplified( +id='ff8081814d977c21014da056804a0af3', +name='Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d', +description='Generic task for terminating data in the overlay, used by the TerminationService.', +launcher='support', +completed=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +launched=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +completion_status='Success' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/python/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..dfaf57c18 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,33 @@ +--- +id: test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestExternalExecuteWorkflow200Response', 'TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/python/v3/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'TestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payload** | **object** | The input that was received | [optional] +} + +## Example + +```python +from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + +test_external_execute_workflow200_response = TestExternalExecuteWorkflow200Response( +payload={test=hello world} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/python/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..8c2041445 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestExternalExecuteWorkflowRequest', 'TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/python/v3/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'TestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow | [optional] +} + +## Example + +```python +from sailpoint.v3.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + +test_external_execute_workflow_request = TestExternalExecuteWorkflowRequest( +input={test=hello world} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TestWorkflow200Response.md b/docs/tools/sdk/python/Reference/V3/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..79cc9ce70 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TestWorkflow200Response.md @@ -0,0 +1,33 @@ +--- +id: test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestWorkflow200Response', 'TestWorkflow200Response'] +slug: /tools/sdk/python/v3/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'TestWorkflow200Response'] +--- + +# TestWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflow_execution_id** | **str** | The workflow execution id | [optional] +} + +## Example + +```python +from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response + +test_workflow200_response = TestWorkflow200Response( +workflow_execution_id='0e11cefa-96e7-4b67-90d0-065bc1da5753' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TestWorkflowRequest.md b/docs/tools/sdk/python/Reference/V3/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..e3a9adc8d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TestWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TestWorkflowRequest', 'TestWorkflowRequest'] +slug: /tools/sdk/python/v3/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'TestWorkflowRequest'] +--- + +# TestWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow. | [required] +} + +## Example + +```python +from sailpoint.v3.models.test_workflow_request import TestWorkflowRequest + +test_workflow_request = TestWorkflowRequest( +input=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TextQuery.md b/docs/tools/sdk/python/Reference/V3/Models/TextQuery.md new file mode 100644 index 000000000..407a4d2ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TextQuery.md @@ -0,0 +1,40 @@ +--- +id: text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TextQuery', 'TextQuery'] +slug: /tools/sdk/python/v3/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'TextQuery'] +--- + +# TextQuery + +Query parameters used to construct an Elasticsearch text query object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terms** | **[]str** | Words or characters that specify a particular thing to be searched for. | [required] +**fields** | **[]str** | The fields to be searched. | [required] +**match_any** | **bool** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to False] +**contains** | **bool** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.text_query import TextQuery + +text_query = TextQuery( +terms=[The quick brown fox, 3141592, 7], +fields=[displayName, employeeNumber, roleCount], +match_any=False, +contains=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TokenAuthRequest.md b/docs/tools/sdk/python/Reference/V3/Models/TokenAuthRequest.md new file mode 100644 index 000000000..324d17e5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TokenAuthRequest.md @@ -0,0 +1,37 @@ +--- +id: token-auth-request +title: TokenAuthRequest +pagination_label: TokenAuthRequest +sidebar_label: TokenAuthRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TokenAuthRequest', 'TokenAuthRequest'] +slug: /tools/sdk/python/v3/models/token-auth-request +tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest', 'TokenAuthRequest'] +--- + +# TokenAuthRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token** | **str** | Token value | [required] +**user_alias** | **str** | User alias from table spt_identity field named 'name' | [required] +**delivery_type** | **Enum** [ 'SMS_PERSONAL', 'VOICE_PERSONAL', 'SMS_WORK', 'VOICE_WORK', 'EMAIL_WORK', 'EMAIL_PERSONAL' ] | Token delivery type | [required] +} + +## Example + +```python +from sailpoint.v3.models.token_auth_request import TokenAuthRequest + +token_auth_request = TokenAuthRequest( +token='12345', +user_alias='will.albin', +delivery_type='EMAIL_WORK' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TokenAuthResponse.md b/docs/tools/sdk/python/Reference/V3/Models/TokenAuthResponse.md new file mode 100644 index 000000000..02e22b279 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TokenAuthResponse.md @@ -0,0 +1,33 @@ +--- +id: token-auth-response +title: TokenAuthResponse +pagination_label: TokenAuthResponse +sidebar_label: TokenAuthResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TokenAuthResponse', 'TokenAuthResponse'] +slug: /tools/sdk/python/v3/models/token-auth-response +tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse', 'TokenAuthResponse'] +--- + +# TokenAuthResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED', 'LOCKOUT', 'NOT_ENOUGH_DATA' ] | MFA Authentication status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.token_auth_response import TokenAuthResponse + +token_auth_response = TokenAuthResponse( +status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Transform.md b/docs/tools/sdk/python/Reference/V3/Models/Transform.md new file mode 100644 index 000000000..957109601 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Transform.md @@ -0,0 +1,38 @@ +--- +id: transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Transform', 'Transform'] +slug: /tools/sdk/python/v3/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'Transform'] +--- + +# Transform + +The representation of an internally- or customer-defined transform. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unique name of this transform | [required] +**type** | **Enum** [ 'accountAttribute', 'base64Decode', 'base64Encode', 'concat', 'conditional', 'dateCompare', 'dateFormat', 'dateMath', 'decomposeDiacriticalMarks', 'e164phone', 'firstValid', 'rule', 'identityAttribute', 'indexOf', 'iso3166', 'lastIndexOf', 'leftPad', 'lookup', 'lower', 'normalizeNames', 'randomAlphaNumeric', 'randomNumeric', 'reference', 'replaceAll', 'replace', 'rightPad', 'split', 'static', 'substring', 'trim', 'upper', 'usernameGenerator', 'uuid', 'displayName', 'rfc5646' ] | The type of transform operation | [required] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [required] +} + +## Example + +```python +from sailpoint.v3.models.transform import Transform + +transform = Transform( +name='Timestamp To Date', +type='dateFormat', +attributes=None +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TransformDefinition.md b/docs/tools/sdk/python/Reference/V3/Models/TransformDefinition.md new file mode 100644 index 000000000..b90808f3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TransformDefinition.md @@ -0,0 +1,35 @@ +--- +id: transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformDefinition', 'TransformDefinition'] +slug: /tools/sdk/python/v3/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefinition'] +--- + +# TransformDefinition + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Transform definition type. | [optional] +**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.transform_definition import TransformDefinition + +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/TransformRead.md b/docs/tools/sdk/python/Reference/V3/Models/TransformRead.md new file mode 100644 index 000000000..564b4552c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TransformRead.md @@ -0,0 +1,41 @@ +--- +id: transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TransformRead', 'TransformRead'] +slug: /tools/sdk/python/v3/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'TransformRead'] +--- + +# TransformRead + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Unique name of this transform | [required] +**type** | **Enum** [ 'accountAttribute', 'base64Decode', 'base64Encode', 'concat', 'conditional', 'dateCompare', 'dateFormat', 'dateMath', 'decomposeDiacriticalMarks', 'e164phone', 'firstValid', 'rule', 'identityAttribute', 'indexOf', 'iso3166', 'lastIndexOf', 'leftPad', 'lookup', 'lower', 'normalizeNames', 'randomAlphaNumeric', 'randomNumeric', 'reference', 'replaceAll', 'replace', 'rightPad', 'split', 'static', 'substring', 'trim', 'upper', 'usernameGenerator', 'uuid', 'displayName', 'rfc5646' ] | The type of transform operation | [required] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [required] +**id** | **str** | Unique ID of this transform | [required] +**internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to False] +} + +## Example + +```python +from sailpoint.v3.models.transform_read import TransformRead + +transform_read = TransformRead( +name='Timestamp To Date', +type='dateFormat', +attributes=sailpoint.v3.models.attributes.attributes(), +id='2cd78adghjkja34jh2b1hkjhasuecd', +internal=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TypeAheadQuery.md b/docs/tools/sdk/python/Reference/V3/Models/TypeAheadQuery.md new file mode 100644 index 000000000..47a44f843 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TypeAheadQuery.md @@ -0,0 +1,46 @@ +--- +id: type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TypeAheadQuery', 'TypeAheadQuery'] +slug: /tools/sdk/python/v3/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'TypeAheadQuery'] +--- + +# TypeAheadQuery + +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.\" + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | The type ahead query string used to construct a phrase prefix match query. | [required] +**var_field** | **str** | The field on which to perform the type ahead search. | [required] +**nested_type** | **str** | The nested type. | [optional] +**max_expansions** | **int** | 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. | [optional] [default to 10] +**size** | **int** | The max amount of records the search will return. | [optional] [default to 100] +**sort** | **str** | The sort order of the returned records. | [optional] [default to 'desc'] +**sort_by_value** | **bool** | The flag that defines the sort type, by count or value. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.type_ahead_query import TypeAheadQuery + +type_ahead_query = TypeAheadQuery( +query='Work', +var_field='source.name', +nested_type='access', +max_expansions=10, +size=100, +sort='desc', +sort_by_value=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/TypedReference.md b/docs/tools/sdk/python/Reference/V3/Models/TypedReference.md new file mode 100644 index 000000000..6c72785f5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/TypedReference.md @@ -0,0 +1,36 @@ +--- +id: typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'TypedReference', 'TypedReference'] +slug: /tools/sdk/python/v3/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'TypedReference'] +--- + +# TypedReference + +A typed reference to the object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [required] +**id** | **str** | The id of the object. | [required] +} + +## Example + +```python +from sailpoint.v3.models.typed_reference import TypedReference + +typed_reference = TypedReference( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..228da3879 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,34 @@ +--- +id: uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UncorrelatedAccountsReportArguments', 'UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/python/v3/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'UncorrelatedAccountsReportArguments'] +--- + +# UncorrelatedAccountsReportArguments + +Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selected_formats** | **[]str** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.uncorrelated_accounts_report_arguments import UncorrelatedAccountsReportArguments + +uncorrelated_accounts_report_arguments = UncorrelatedAccountsReportArguments( +selected_formats=[CSV] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/UpdateDetail.md b/docs/tools/sdk/python/Reference/V3/Models/UpdateDetail.md new file mode 100644 index 000000000..6dc5f3c60 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/UpdateDetail.md @@ -0,0 +1,39 @@ +--- +id: update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UpdateDetail', 'UpdateDetail'] +slug: /tools/sdk/python/v3/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'UpdateDetail'] +--- + +# UpdateDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**script_name** | **str** | The connector script name | [optional] +**updated_files** | **[]str** | The list of updated files supported by the connector | [optional] +**status** | **Enum** [ 'ERROR', 'UPDATED', 'UNCHANGED', 'SKIPPED' ] | The connector update status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.update_detail import UpdateDetail + +update_detail = UpdateDetail( +message='unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config', +script_name='servicenow', +updated_files=[pod/org/connectorFiles/testconnector/test1.jar], +status='ERROR' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/UsageType.md b/docs/tools/sdk/python/Reference/V3/Models/UsageType.md new file mode 100644 index 000000000..807e2ad68 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/UsageType.md @@ -0,0 +1,51 @@ +--- +id: usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'UsageType', 'UsageType'] +slug: /tools/sdk/python/v3/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', '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. + +## Enum + +* `CREATE` (value: `'CREATE'`) + +* `UPDATE` (value: `'UPDATE'`) + +* `ENABLE` (value: `'ENABLE'`) + +* `DISABLE` (value: `'DISABLE'`) + +* `DELETE` (value: `'DELETE'`) + +* `ASSIGN` (value: `'ASSIGN'`) + +* `UNASSIGN` (value: `'UNASSIGN'`) + +* `CREATE_GROUP` (value: `'CREATE_GROUP'`) + +* `UPDATE_GROUP` (value: `'UPDATE_GROUP'`) + +* `DELETE_GROUP` (value: `'DELETE_GROUP'`) + +* `REGISTER` (value: `'REGISTER'`) + +* `CREATE_IDENTITY` (value: `'CREATE_IDENTITY'`) + +* `UPDATE_IDENTITY` (value: `'UPDATE_IDENTITY'`) + +* `EDIT_GROUP` (value: `'EDIT_GROUP'`) + +* `UNLOCK` (value: `'UNLOCK'`) + +* `CHANGE_PASSWORD` (value: `'CHANGE_PASSWORD'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/V3ConnectorDto.md b/docs/tools/sdk/python/Reference/V3/Models/V3ConnectorDto.md new file mode 100644 index 000000000..643b354a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/V3ConnectorDto.md @@ -0,0 +1,47 @@ +--- +id: v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'V3ConnectorDto', 'V3ConnectorDto'] +slug: /tools/sdk/python/v3/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V3ConnectorDto'] +--- + +# V3ConnectorDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The connector name | [optional] +**type** | **str** | The connector type | [optional] +**script_name** | **str** | The connector script name | [optional] +**class_name** | **str** | The connector class name. | [optional] +**features** | **[]str** | The list of features supported by the connector | [optional] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to False] +**connector_metadata** | **map[string]object** | A map containing metadata pertinent to the connector | [optional] +**status** | **Enum** [ 'DEPRECATED', 'DEVELOPMENT', 'DEMO', 'RELEASED' ] | The connector status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto + +v3_connector_dto = V3ConnectorDto( +name='name', +type='ServiceNow', +script_name='servicenow', +class_name='sailpoint.connector.OpenConnectorAdapter', +features=[PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS], +direct_connect=True, +connector_metadata={supportedUI=ANGULAR, platform=ccg, shortDesc=connector description}, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/V3CreateConnectorDto.md b/docs/tools/sdk/python/Reference/V3/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..e9a73e874 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/V3CreateConnectorDto.md @@ -0,0 +1,41 @@ +--- +id: v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'V3CreateConnectorDto', 'V3CreateConnectorDto'] +slug: /tools/sdk/python/v3/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V3CreateConnectorDto'] +--- + +# V3CreateConnectorDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | 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 | [required] +**type** | **str** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**class_name** | **str** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | [required] +**direct_connect** | **bool** | true if the source is a direct connect source | [optional] [default to True] +**status** | **Enum** [ 'DEVELOPMENT', 'DEMO', 'RELEASED' ] | The connector status | [optional] +} + +## Example + +```python +from sailpoint.v3.models.v3_create_connector_dto import V3CreateConnectorDto + +v3_create_connector_dto = V3CreateConnectorDto( +name='custom connector', +type='custom connector type', +class_name='sailpoint.connector.OpenConnectorAdapter', +direct_connect=True, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Value.md b/docs/tools/sdk/python/Reference/V3/Models/Value.md new file mode 100644 index 000000000..2efd8bad2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Value.md @@ -0,0 +1,35 @@ +--- +id: value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Value', 'Value'] +slug: /tools/sdk/python/v3/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'Value'] +--- + +# Value + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of attribute value | [optional] +**value** | **str** | The attribute value | [optional] +} + +## Example + +```python +from sailpoint.v3.models.value import Value + +value = Value( +type='STRING', +value='Austin' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMapping.md b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..76f93e754 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMapping.md @@ -0,0 +1,57 @@ +--- +id: vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMapping', 'VendorConnectorMapping'] +slug: /tools/sdk/python/v3/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'VendorConnectorMapping'] +--- + +# VendorConnectorMapping + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier for the vendor-connector mapping. | [optional] +**vendor** | **str** | The name of the vendor. | [optional] +**connector** | **str** | The name of the connector. | [optional] +**created_at** | **datetime** | The creation timestamp of the mapping. | [optional] +**created_by** | **str** | The identifier of the user who created the mapping. | [optional] +**updated_at** | [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**updated_by** | [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**deleted_at** | [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**deleted_by** | [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping + +vendor_connector_mapping = VendorConnectorMapping( +id='78733556-9ea3-4f59-bf69-e5cd92b011b4', +vendor='Example vendor', +connector='Example connector', +created_at='2024-03-13T12:56:19.391294Z', +created_by='admin', +updated_at=sailpoint.v3.models.vendor_connector_mapping_updated_at.VendorConnectorMapping_updatedAt( + time = '2024-03-14T12:56:19.391294Z', + valid = True, ), +updated_by=sailpoint.v3.models.vendor_connector_mapping_updated_by.VendorConnectorMapping_updatedBy( + string = 'user-67891', + valid = True, ), +deleted_at=sailpoint.v3.models.vendor_connector_mapping_deleted_at.VendorConnectorMapping_deletedAt( + time = '0001-01-01T00:00Z', + valid = False, ), +deleted_by=sailpoint.v3.models.vendor_connector_mapping_deleted_by.VendorConnectorMapping_deletedBy( + string = '', + valid = False, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..15556e188 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,36 @@ +--- +id: vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingDeletedAt', 'VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/python/v3/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'VendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +An object representing the nullable timestamp of when the mapping was deleted. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**valid** | **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.vendor_connector_mapping_deleted_at import VendorConnectorMappingDeletedAt + +vendor_connector_mapping_deleted_at = VendorConnectorMappingDeletedAt( +time='0001-01-01T00:00Z', +valid=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..1bfb47035 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,36 @@ +--- +id: vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingDeletedBy', 'VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/python/v3/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'VendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +An object representing the nullable identifier of the user who deleted the mapping. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**string** | **str** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**valid** | **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.vendor_connector_mapping_deleted_by import VendorConnectorMappingDeletedBy + +vendor_connector_mapping_deleted_by = VendorConnectorMappingDeletedBy( +string='', +valid=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..0bdfb1feb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,36 @@ +--- +id: vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingUpdatedAt', 'VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/python/v3/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'VendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +An object representing the nullable timestamp of the last update. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time** | **datetime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**valid** | **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.vendor_connector_mapping_updated_at import VendorConnectorMappingUpdatedAt + +vendor_connector_mapping_updated_at = VendorConnectorMappingUpdatedAt( +time='2024-03-14T12:56:19.391294Z', +valid=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..396a2f219 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,36 @@ +--- +id: vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VendorConnectorMappingUpdatedBy', 'VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/python/v3/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'VendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +An object representing the nullable identifier of the user who last updated the mapping. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**string** | **str** | The identifier of the user who last updated the mapping, if available. | [optional] +**valid** | **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.vendor_connector_mapping_updated_by import VendorConnectorMappingUpdatedBy + +vendor_connector_mapping_updated_by = VendorConnectorMappingUpdatedBy( +string='user-67891', +valid=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VerificationPollRequest.md b/docs/tools/sdk/python/Reference/V3/Models/VerificationPollRequest.md new file mode 100644 index 000000000..d4776b2b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VerificationPollRequest.md @@ -0,0 +1,33 @@ +--- +id: verification-poll-request +title: VerificationPollRequest +pagination_label: VerificationPollRequest +sidebar_label: VerificationPollRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VerificationPollRequest', 'VerificationPollRequest'] +slug: /tools/sdk/python/v3/models/verification-poll-request +tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest', 'VerificationPollRequest'] +--- + +# VerificationPollRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | Verification request Id | [required] +} + +## Example + +```python +from sailpoint.v3.models.verification_poll_request import VerificationPollRequest + +verification_poll_request = VerificationPollRequest( +request_id='089899f13a8f4da7824996191587bab9' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/VerificationResponse.md b/docs/tools/sdk/python/Reference/V3/Models/VerificationResponse.md new file mode 100644 index 000000000..e1ab89cfc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VerificationResponse.md @@ -0,0 +1,37 @@ +--- +id: verification-response +title: VerificationResponse +pagination_label: VerificationResponse +sidebar_label: VerificationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VerificationResponse', 'VerificationResponse'] +slug: /tools/sdk/python/v3/models/verification-response +tags: ['SDK', 'Software Development Kit', 'VerificationResponse', 'VerificationResponse'] +--- + +# VerificationResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_id** | **str** | The verificationPollRequest request ID | [optional] +**status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED', 'LOCKOUT', 'NOT_ENOUGH_DATA' ] | MFA Authentication status | [optional] +**error** | **str** | Error messages from MFA verification request | [optional] +} + +## Example + +```python +from sailpoint.v3.models.verification_response import VerificationResponse + +verification_response = VerificationResponse( +request_id='089899f13a8f4da7824996191587bab9', +status='SUCCESS', +error='Unable to connect DUO Service during verification' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ViolationContext.md b/docs/tools/sdk/python/Reference/V3/Models/ViolationContext.md new file mode 100644 index 000000000..9a435d6c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ViolationContext.md @@ -0,0 +1,40 @@ +--- +id: violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationContext', 'ViolationContext'] +slug: /tools/sdk/python/v3/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'ViolationContext'] +--- + +# ViolationContext + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**conflicting_access_criteria** | [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.violation_context import ViolationContext + +violation_context = ViolationContext( +policy=sailpoint.v3.models.violation_context_policy.ViolationContext_policy( + type = ENTITLEMENT, ), +conflicting_access_criteria=sailpoint.v3.models.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/ViolationContextPolicy.md b/docs/tools/sdk/python/Reference/V3/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..31ebd9a48 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ViolationContextPolicy.md @@ -0,0 +1,38 @@ +--- +id: violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationContextPolicy', 'ViolationContextPolicy'] +slug: /tools/sdk/python/v3/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'ViolationContextPolicy'] +--- + +# ViolationContextPolicy + +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** | SOD policy ID. | [optional] +**name** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.violation_context_policy import ViolationContextPolicy + +violation_context_policy = ViolationContextPolicy( +type=ENTITLEMENT, +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='A very cool policy name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/python/Reference/V3/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..2380aaf28 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,38 @@ +--- +id: violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationOwnerAssignmentConfig', 'ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/python/v3/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'ViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignment_rule** | **Enum** [ 'MANAGER', 'STATIC' ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**owner_ref** | [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.violation_owner_assignment_config import ViolationOwnerAssignmentConfig + +violation_owner_assignment_config = ViolationOwnerAssignmentConfig( +assignment_rule='MANAGER', +owner_ref=sailpoint.v3.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/python/Reference/V3/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..14232be9e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,38 @@ +--- +id: violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/python/v3/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'ViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +The owner of the violation assignment config. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP', 'MANAGER' ] | Owner type. | [optional] +**id** | **str** | Owner's ID. | [optional] +**name** | **str** | Owner's name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.violation_owner_assignment_config_owner_ref import ViolationOwnerAssignmentConfigOwnerRef + +violation_owner_assignment_config_owner_ref = ViolationOwnerAssignmentConfigOwnerRef( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Support' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ViolationPrediction.md b/docs/tools/sdk/python/Reference/V3/Models/ViolationPrediction.md new file mode 100644 index 000000000..dab2b4560 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ViolationPrediction.md @@ -0,0 +1,43 @@ +--- +id: violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ViolationPrediction', 'ViolationPrediction'] +slug: /tools/sdk/python/v3/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'ViolationPrediction'] +--- + +# ViolationPrediction + +An object containing a listing of the SOD violation reasons detected by this check. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**violation_contexts** | [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] +} + +## Example + +```python +from sailpoint.v3.models.violation_prediction import ViolationPrediction + +violation_prediction = ViolationPrediction( +violation_contexts=[ + sailpoint.v3.models.violation_context.ViolationContext( + policy = sailpoint.v3.models.violation_context_policy.ViolationContext_policy( + type = ENTITLEMENT, ), + conflicting_access_criteria = sailpoint.v3.models.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/VisibilityCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/VisibilityCriteria.md new file mode 100644 index 000000000..2d446c94d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/VisibilityCriteria.md @@ -0,0 +1,38 @@ +--- +id: visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'VisibilityCriteria', 'VisibilityCriteria'] +slug: /tools/sdk/python/v3/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'VisibilityCriteria'] +--- + +# VisibilityCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | [**Expression**](expression) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.visibility_criteria import VisibilityCriteria + +visibility_criteria = VisibilityCriteria( +expression=sailpoint.v3.models.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/WorkItemForward.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemForward.md new file mode 100644 index 000000000..a18b78a71 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemForward.md @@ -0,0 +1,37 @@ +--- +id: work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemForward', 'WorkItemForward'] +slug: /tools/sdk/python/v3/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'WorkItemForward'] +--- + +# WorkItemForward + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_owner_id** | **str** | The ID of the identity to forward this work item to. | [required] +**comment** | **str** | Comments to send to the target owner | [required] +**send_notifications** | **bool** | If true, send a notification to the target owner. | [optional] [default to True] +} + +## Example + +```python +from sailpoint.v3.models.work_item_forward import WorkItemForward + +work_item_forward = WorkItemForward( +target_owner_id='2c9180835d2e5168015d32f890ca1581', +comment='I'm going on vacation.', +send_notifications=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkItemState.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemState.md new file mode 100644 index 000000000..1a4ca3d8e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemState.md @@ -0,0 +1,31 @@ +--- +id: work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemState', 'WorkItemState'] +slug: /tools/sdk/python/v3/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'WorkItemState'] +--- + +# WorkItemState + +The state of a work item + +## Enum + +* `FINISHED` (value: `'Finished'`) + +* `REJECTED` (value: `'Rejected'`) + +* `RETURNED` (value: `'Returned'`) + +* `EXPIRED` (value: `'Expired'`) + +* `PENDING` (value: `'Pending'`) + +* `CANCELED` (value: `'Canceled'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..2d8fe20ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,31 @@ +--- +id: work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemStateManualWorkItems', 'WorkItemStateManualWorkItems'] +slug: /tools/sdk/python/v3/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'WorkItemStateManualWorkItems'] +--- + +# WorkItemStateManualWorkItems + +The state of a work item + +## Enum + +* `FINISHED` (value: `'Finished'`) + +* `REJECTED` (value: `'Rejected'`) + +* `RETURNED` (value: `'Returned'`) + +* `EXPIRED` (value: `'Expired'`) + +* `PENDING` (value: `'Pending'`) + +* `CANCELED` (value: `'Canceled'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..5a13222a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,47 @@ +--- +id: work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemTypeManualWorkItems', 'WorkItemTypeManualWorkItems'] +slug: /tools/sdk/python/v3/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'WorkItemTypeManualWorkItems'] +--- + +# WorkItemTypeManualWorkItems + +The type of the work item + +## Enum + +* `GENERIC` (value: `'Generic'`) + +* `CERTIFICATION` (value: `'Certification'`) + +* `REMEDIATION` (value: `'Remediation'`) + +* `DELEGATION` (value: `'Delegation'`) + +* `APPROVAL` (value: `'Approval'`) + +* `VIOLATIONREVIEW` (value: `'ViolationReview'`) + +* `FORM` (value: `'Form'`) + +* `POLICYVIOLOATION` (value: `'PolicyVioloation'`) + +* `CHALLENGE` (value: `'Challenge'`) + +* `IMPACTANALYSIS` (value: `'ImpactAnalysis'`) + +* `SIGNOFF` (value: `'Signoff'`) + +* `EVENT` (value: `'Event'`) + +* `MANUALACTION` (value: `'ManualAction'`) + +* `TEST` (value: `'Test'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkItems.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItems.md new file mode 100644 index 000000000..749de57a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItems.md @@ -0,0 +1,85 @@ +--- +id: work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItems', 'WorkItems'] +slug: /tools/sdk/python/v3/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'WorkItems'] +--- + +# WorkItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the work item | [optional] +**requester_id** | **str** | ID of the requester | [optional] +**requester_display_name** | **str** | The displayname of the requester | [optional] +**owner_id** | **str** | The ID of the owner | [optional] +**owner_name** | **str** | The name of the owner | [optional] +**created** | **datetime** | Time when the work item was created | [optional] +**modified** | **datetime** | Time when the work item was last updated | [optional] +**description** | **str** | The description of the work item | [optional] +**state** | [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**type** | [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**remediation_items** | [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**approval_items** | [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**name** | **str** | The work item name | [optional] +**completed** | **datetime** | The time at which the work item completed | [optional] +**num_items** | **int** | The number of items in the work item | [optional] +**form** | [**WorkItemsForm**](work-items-form) | | [optional] +**errors** | **[]str** | An array of errors that ocurred during the work item | [optional] +} + +## Example + +```python +from sailpoint.v3.models.work_items import WorkItems + +work_items = WorkItems( +id='2c9180835d2e5168015d32f890ca1581', +requester_id='2c9180835d2e5168015d32f890ca1581', +requester_display_name='John Smith', +owner_id='2c9180835d2e5168015d32f890ca1581', +owner_name='Jason Smith', +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +description='Create account on source 'AD'', +state='Finished', +type='Generic', +remediation_items=[ + sailpoint.v3.models.remediation_item_details.RemediationItemDetails( + id = '2c9180835d2e5168015d32f890ca1581', + target_id = '2c9180835d2e5168015d32f890ca1581', + target_name = 'john.smith', + target_display_name = 'emailAddress', + application_name = 'Active Directory', + attribute_name = 'phoneNumber', + attribute_operation = 'update', + attribute_value = '512-555-1212', + native_identity = 'jason.smith2', ) + ], +approval_items=[ + sailpoint.v3.models.approval_item_details.ApprovalItemDetails( + id = '2c9180835d2e5168015d32f890ca1581', + account = 'john.smith', + application = 'Active Directory', + name = 'emailAddress', + operation = 'update', + value = 'a@b.com', + state = null, ) + ], +name='Account Create', +completed='2018-10-19T13:49:37.385Z', +num_items=19, +form=, +errors=[The work item ID that was specified was not found.] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkItemsCount.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemsCount.md new file mode 100644 index 000000000..4f9e86bed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemsCount.md @@ -0,0 +1,33 @@ +--- +id: work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsCount', 'WorkItemsCount'] +slug: /tools/sdk/python/v3/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'WorkItemsCount'] +--- + +# WorkItemsCount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | The count of work items | [optional] +} + +## Example + +```python +from sailpoint.v3.models.work_items_count import WorkItemsCount + +work_items_count = WorkItemsCount( +count=29 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkItemsForm.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemsForm.md new file mode 100644 index 000000000..c81c3a3db --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemsForm.md @@ -0,0 +1,45 @@ +--- +id: work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsForm', 'WorkItemsForm'] +slug: /tools/sdk/python/v3/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'WorkItemsForm'] +--- + +# WorkItemsForm + + +## 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.work_items_form import WorkItemsForm + +work_items_form = WorkItemsForm( +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/WorkItemsSummary.md b/docs/tools/sdk/python/Reference/V3/Models/WorkItemsSummary.md new file mode 100644 index 000000000..da110e976 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkItemsSummary.md @@ -0,0 +1,37 @@ +--- +id: work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkItemsSummary', 'WorkItemsSummary'] +slug: /tools/sdk/python/v3/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'WorkItemsSummary'] +--- + +# WorkItemsSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**open** | **int** | The count of open work items | [optional] +**completed** | **int** | The count of completed work items | [optional] +**total** | **int** | The count of total work items | [optional] +} + +## Example + +```python +from sailpoint.v3.models.work_items_summary import WorkItemsSummary + +work_items_summary = WorkItemsSummary( +open=29, +completed=1, +total=30 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Workflow.md b/docs/tools/sdk/python/Reference/V3/Models/Workflow.md new file mode 100644 index 000000000..bcdfbe807 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Workflow.md @@ -0,0 +1,71 @@ +--- +id: workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Workflow', 'Workflow'] +slug: /tools/sdk/python/v3/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'Workflow'] +--- + +# Workflow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [optional] +**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] +**id** | **str** | Workflow ID. This is a UUID generated upon creation. | [optional] +**execution_count** | **int** | The number of times this workflow has been executed. | [optional] +**failure_count** | **int** | The number of times this workflow has failed during execution. | [optional] +**created** | **datetime** | The date and time the workflow was created. | [optional] +**modified** | **datetime** | The date and time the workflow was modified. | [optional] +**modified_by** | [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**creator** | [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow import Workflow + +workflow = Workflow( +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, ), +id='d201c5e9-d37b-4aff-af14-66414f39d569', +execution_count=2, +failure_count=0, +created='2022-01-10T16:06:16.636381447Z', +modified='2023-12-05T15:18:27.699132301Z', +modified_by=sailpoint.v3.models.workflow_modified_by.WorkflowModifiedBy( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Thomas Edison', ), +creator=sailpoint.v3.models.workflow_all_of_creator.Workflow_allOf_creator( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..466d1abf9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowAllOfCreator.md @@ -0,0 +1,38 @@ +--- +id: workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowAllOfCreator', 'WorkflowAllOfCreator'] +slug: /tools/sdk/python/v3/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'WorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +Workflow creator's identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Workflow creator's DTO type. | [optional] +**id** | **str** | Workflow creator's identity ID. | [optional] +**name** | **str** | Workflow creator's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_all_of_creator import WorkflowAllOfCreator + +workflow_all_of_creator = WorkflowAllOfCreator( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowBody.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowBody.md new file mode 100644 index 000000000..9379860a0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowBody.md @@ -0,0 +1,51 @@ +--- +id: workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowBody', 'WorkflowBody'] +slug: /tools/sdk/python/v3/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'WorkflowBody'] +--- + +# WorkflowBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [optional] +**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.workflow_body import WorkflowBody + +workflow_body = WorkflowBody( +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/WorkflowBodyOwner.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..f794427fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowBodyOwner.md @@ -0,0 +1,38 @@ +--- +id: workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowBodyOwner', 'WorkflowBodyOwner'] +slug: /tools/sdk/python/v3/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'WorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [optional] +**id** | **str** | The unique ID of the object | [optional] +**name** | **str** | The name of the object | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_body_owner import WorkflowBodyOwner + +workflow_body_owner = WorkflowBodyOwner( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowDefinition.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowDefinition.md new file mode 100644 index 000000000..ca105dfd0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowDefinition.md @@ -0,0 +1,36 @@ +--- +id: workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowDefinition', 'WorkflowDefinition'] +slug: /tools/sdk/python/v3/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'WorkflowDefinition'] +--- + +# WorkflowDefinition + +The map of steps that the workflow will execute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **str** | The name of the starting step. | [optional] +**steps** | **map[string]object** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_definition import WorkflowDefinition + +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}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md new file mode 100644 index 000000000..f2c4be952 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md @@ -0,0 +1,43 @@ +--- +id: workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowExecution', 'WorkflowExecution'] +slug: /tools/sdk/python/v3/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'WorkflowExecution'] +--- + +# WorkflowExecution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Workflow execution ID. | [optional] +**workflow_id** | **str** | Workflow ID. | [optional] +**request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**start_time** | **datetime** | Date/time when the workflow started. | [optional] +**close_time** | **datetime** | Date/time when the workflow ended. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_execution import WorkflowExecution + +workflow_execution = WorkflowExecution( +id='b393f4e2-4785-4d7f-ab27-3a6b8ded4c81', +workflow_id='d201c5d9-d37b-4a2f-af14-66414f39d568', +request_id='41e12a74fa7b4a6a98ae47887b64acdb', +start_time='2022-02-07T20:13:29.356648026Z', +close_time='2022-02-07T20:13:31.682410165Z', +status='Completed' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..89c75163a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecutionEvent.md @@ -0,0 +1,37 @@ +--- +id: workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowExecutionEvent', 'WorkflowExecutionEvent'] +slug: /tools/sdk/python/v3/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'WorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WorkflowExecutionScheduled', 'WorkflowExecutionStarted', 'WorkflowExecutionCompleted', 'WorkflowExecutionFailed', 'WorkflowTaskScheduled', 'WorkflowTaskStarted', 'WorkflowTaskCompleted', 'WorkflowTaskFailed', 'ActivityTaskScheduled', 'ActivityTaskStarted', 'ActivityTaskCompleted', 'ActivityTaskFailed', 'StartChildWorkflowExecutionInitiated', 'ChildWorkflowExecutionStarted', 'ChildWorkflowExecutionCompleted', 'ChildWorkflowExecutionFailed' ] | The type of event | [optional] +**timestamp** | **datetime** | The date-time when the event occurred | [optional] +**attributes** | **object** | Additional attributes associated with the event | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent + +workflow_execution_event = WorkflowExecutionEvent( +type='WorkflowTaskScheduled', +timestamp='2022-02-07T20:13:31.640618296Z', +attributes={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryAction.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..89be35efd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryAction.md @@ -0,0 +1,63 @@ +--- +id: workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryAction', 'WorkflowLibraryAction'] +slug: /tools/sdk/python/v3/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'WorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Action ID. This is a static namespaced ID for the action | [optional] +**name** | **str** | Action Name | [optional] +**type** | **str** | Action type | [optional] +**description** | **str** | Action Description | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**example_output** | [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**version_number** | **int** | Version number | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to False] +**output_schema** | **object** | Defines the output schema, if any, that this action produces. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction + +workflow_library_action = WorkflowLibraryAction( +id='sp:create-campaign', +name='Create Certification Campaign', +type='ACTION', +description='Generates a certification campaign.', +form_fields=[ + sailpoint.v3.models.workflow_library_form_fields.WorkflowLibraryFormFields( + description = 'First value to compare', + help_text = 'The name to give to this certification campaign.', + label = 'Campaign Name', + name = 'name', + required = False, + type = 'text', ) + ], +example_output=, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +version_number=56, +is_simulation_enabled=True, +is_dynamic_schema=False, +output_schema={definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..ff985ab9a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,31 @@ +--- +id: workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryActionExampleOutput', 'WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/python/v3/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'WorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v3.models.workflow_library_action_example_output import WorkflowLibraryActionExampleOutput + +workflow_library_action_example_output = WorkflowLibraryActionExampleOutput( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..6f580548c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,43 @@ +--- +id: workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryFormFields', 'WorkflowLibraryFormFields'] +slug: /tools/sdk/python/v3/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'WorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Description of the form field | [optional] +**help_text** | **str** | Describes the form field in the UI | [optional] +**label** | **str** | A human readable name for this form field in the UI | [optional] +**name** | **str** | The name of the input attribute | [optional] +**required** | **bool** | Denotes if this field is a required attribute | [optional] [default to False] +**type** | **Enum** [ 'text', 'textarea', 'boolean', 'email', 'url', 'number', 'json', 'checkbox', 'jsonpath', 'select', 'multiType', 'duration', 'toggle', 'formPicker', 'identityPicker', 'governanceGroupPicker', 'string', 'object', 'array', 'secret', 'keyValuePairs', 'emailPicker', 'advancedToggle', 'variableCreator', 'htmlEditor' ] | The type of the form field | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_library_form_fields import WorkflowLibraryFormFields + +workflow_library_form_fields = WorkflowLibraryFormFields( +description='First value to compare', +help_text='The name to give to this certification campaign.', +label='Campaign Name', +name='name', +required=False, +type='text' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..5a6e93612 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryOperator.md @@ -0,0 +1,49 @@ +--- +id: workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryOperator', 'WorkflowLibraryOperator'] +slug: /tools/sdk/python/v3/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'WorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Operator ID. | [optional] +**name** | **str** | Operator friendly name | [optional] +**type** | **str** | Operator type | [optional] +**description** | **str** | Description of the operator | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator + +workflow_library_operator = WorkflowLibraryOperator( +id='sp:compare-boolean', +name='Compare Boolean Values', +type='OPERATOR', +description='Compare two boolean values and decide what happens based on the result.', +is_dynamic_schema=False, +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +is_simulation_enabled=True, +form_fields=[{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..8236fd12b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,53 @@ +--- +id: workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowLibraryTrigger', 'WorkflowLibraryTrigger'] +slug: /tools/sdk/python/v3/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'WorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**type** | **Enum** [ 'EVENT', 'SCHEDULED', 'EXTERNAL' ] | Trigger type | [optional] +**deprecated** | **bool** | | [optional] +**deprecated_by** | **datetime** | | [optional] +**is_simulation_enabled** | **bool** | | [optional] +**output_schema** | **object** | Example output schema | [optional] +**name** | **str** | Trigger Name | [optional] +**description** | **str** | Trigger Description | [optional] +**is_dynamic_schema** | **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to False] +**input_example** | **object** | Example trigger payload if applicable | [optional] +**form_fields** | [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger + +workflow_library_trigger = WorkflowLibraryTrigger( +id='idn:identity-attributes-changed', +type='EVENT', +deprecated=True, +deprecated_by=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), +is_simulation_enabled=True, +output_schema=None, +name='Identity Attributes Changed', +description='One or more identity attributes changed.', +is_dynamic_schema=False, +input_example={changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}}, +form_fields=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowModifiedBy.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..37d1179df --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowModifiedBy.md @@ -0,0 +1,37 @@ +--- +id: workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowModifiedBy', 'WorkflowModifiedBy'] +slug: /tools/sdk/python/v3/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'WorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | | [optional] +**id** | **str** | Identity ID | [optional] +**name** | **str** | Human-readable display name of identity. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_modified_by import WorkflowModifiedBy + +workflow_modified_by = WorkflowModifiedBy( +type='IDENTITY', +id='2c9180a46faadee4016fb4e018c20639', +name='Thomas Edison' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowOAuthClient.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..016208c49 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowOAuthClient.md @@ -0,0 +1,37 @@ +--- +id: workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowOAuthClient', 'WorkflowOAuthClient'] +slug: /tools/sdk/python/v3/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'WorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**secret** | **str** | OAuthClient secret. | [optional] +**url** | **str** | URL for the external trigger to invoke | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient + +workflow_o_auth_client = WorkflowOAuthClient( +id='1a58c03a6bf64dc2876f6988c6e2c7b7', +secret='00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowTrigger.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowTrigger.md new file mode 100644 index 000000000..0461cf82f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowTrigger.md @@ -0,0 +1,38 @@ +--- +id: workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowTrigger', 'WorkflowTrigger'] +slug: /tools/sdk/python/v3/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'WorkflowTrigger'] +--- + +# WorkflowTrigger + +The trigger that starts the workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'EVENT', 'EXTERNAL', 'SCHEDULED', '' ] | The trigger type | [required] +**display_name** | **str** | | [optional] +**attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] +} + +## Example + +```python +from sailpoint.v3.models.workflow_trigger import WorkflowTrigger + +workflow_trigger = WorkflowTrigger( +type='EVENT', +display_name='', +attributes= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowTriggerAttributes.md new file mode 100644 index 000000000..519e70a2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowTriggerAttributes.md @@ -0,0 +1,56 @@ +--- +id: workflow-trigger-attributes +title: WorkflowTriggerAttributes +pagination_label: WorkflowTriggerAttributes +sidebar_label: WorkflowTriggerAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'WorkflowTriggerAttributes', 'WorkflowTriggerAttributes'] +slug: /tools/sdk/python/v3/models/workflow-trigger-attributes +tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'WorkflowTriggerAttributes'] +--- + +# WorkflowTriggerAttributes + +Workflow Trigger Attributes. + +## 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** | Additonal context about the external trigger | [optional] +**attribute_to_filter** | **str** | The attribute to filter on | [optional] +**name** | **str** | A unique name for the external trigger | [optional] +**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional] +**url** | **str** | URL to invoke this workflow | [optional] +**cron_string** | **str** | A valid CRON expression | [optional] +**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required] +**time_zone** | **str** | Time zone identifier | [optional] +**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional] +**weekly_times** | **[]str** | Scheduled execution times | [optional] +} + +## Example + +```python +from sailpoint.v3.models.workflow_trigger_attributes import WorkflowTriggerAttributes + +workflow_trigger_attributes = WorkflowTriggerAttributes( +id='idn:identity-attributes-changed', +filter_='$.changes[?(@.attribute == 'manager')]', +description='Run a search and notify the results', +attribute_to_filter='LifecycleState', +name='search-and-notify', +client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d', +cron_string='0 9 * * 1', +frequency='daily', +time_zone='America/Chicago', +weekly_days=Monday, +weekly_times=Monday +) + +``` +[[Back to top]](#) + diff --git a/package.json b/package.json index df3bac802..d48ea8012 100644 --- a/package.json +++ b/package.json @@ -16,16 +16,20 @@ "clean-api-docs": "docusaurus clean-api-docs", "gen-api-docs:version": "docusaurus gen-api-docs:version", "clean-api-docs:version": "docusaurus clean-api-docs:version", - "gen-api-docs-all": "npm run gen-all-api-specs-code-examples && docusaurus gen-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus gen-api-docs isc_versioned --plugin-id isc-api && docusaurus gen-api-docs iiq --plugin-id iiq-api && docusaurus gen-api-docs nerm --plugin-id nerm-api", + "gen-api-docs-all": "npm run merge-all-code-examples && npm run gen-all-api-specs-code-examples && docusaurus gen-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus gen-api-docs isc_versioned --plugin-id isc-api && docusaurus gen-api-docs iiq --plugin-id iiq-api && docusaurus gen-api-docs nerm --plugin-id nerm-api", "clean-api-docs-all": "docusaurus clean-api-docs isc_versioned --plugin-id isc-api && docusaurus clean-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus clean-api-docs iiq --plugin-id iiq-api && docusaurus clean-api-docs nerm --plugin-id nerm-api", "rebuild-docs": "npm run clean-api-docs-all && npm run gen-api-docs-all", + "beta-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/beta/python_code_examples_overlay.yaml static/code-examples/beta/powershell_code_examples_overlay.yaml", "speecy-beta-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.beta.yaml -o static/code-examples/beta/beta.yaml", - "overlay-code-examples-beta": "node src/components/overlay.js static/code-examples/beta/beta.yaml static/code-examples/beta/powershell_code_examples_overlay.yaml", + "overlay-code-examples-beta": "node src/components/overlay.js static/code-examples/beta/beta.yaml static/code-examples/beta/merged_code_examples.yaml", + "v3-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v3/python_code_examples_overlay.yaml static/code-examples/v3/powershell_code_examples_overlay.yaml", "speecy-v3-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.v3.yaml -o static/code-examples/v3/v3.yaml", - "overlay-code-examples-v3": "node src/components/overlay.js static/code-examples/v3/v3.yaml static/code-examples/v3/powershell_code_examples_overlay.yaml", + "overlay-code-examples-v3": "node src/components/overlay.js static/code-examples/v3/v3.yaml static/code-examples/v3/merged_code_examples.yaml", + "v2024-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v2024/python_code_examples_overlay.yaml static/code-examples/v2024/powershell_code_examples_overlay.yaml", "speecy-v2024-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.v2024.yaml -o static/code-examples/v2024/v2024.yaml", - "overlay-code-examples-v2024": "node src/components/overlay.js static/code-examples/v2024/v2024.yaml static/code-examples/v2024/powershell_code_examples_overlay.yaml", - "gen-all-api-specs-code-examples": "npm run speecy-beta-spec && npm run overlay-code-examples-beta && npm run speecy-v3-spec && npm run overlay-code-examples-v3 && npm run speecy-v2024-spec && npm run overlay-code-examples-v2024" + "overlay-code-examples-v2024": "node src/components/overlay.js static/code-examples/v2024/v2024.yaml static/code-examples/v2024/merged_code_examples.yaml", + "gen-all-api-specs-code-examples": "npm run speecy-beta-spec && npm run overlay-code-examples-beta && npm run speecy-v3-spec && npm run overlay-code-examples-v3 && npm run speecy-v2024-spec && npm run overlay-code-examples-v2024", + "merge-all-code-examples": "npm run beta-merge-code-examples && npm run v3-merge-code-examples && npm run v2024-merge-code-examples" }, "dependencies": { "@docusaurus/faster": "^3.7.0", diff --git a/src/components/mergeoverlayfiles.js b/src/components/mergeoverlayfiles.js new file mode 100644 index 000000000..942d2b85c --- /dev/null +++ b/src/components/mergeoverlayfiles.js @@ -0,0 +1,86 @@ +const fs = require('fs'); +const yaml = require('js-yaml'); +const path = require('path'); + +// Get file paths from command line arguments +const pythonFilePath = process.argv[2]; +const powershellFilePath = process.argv[3]; + +// Check if the correct number of arguments is passed +if (!pythonFilePath || !powershellFilePath) { + console.error('Please provide the paths for the Python and PowerShell YAML files.'); + process.exit(1); +} + +// Read both YAML files +const powershellFile = fs.readFileSync(powershellFilePath, 'utf8'); +const pythonFile = fs.readFileSync(pythonFilePath, 'utf8'); + +// Parse both YAML files +const powershellData = yaml.load(powershellFile); +const pythonData = yaml.load(pythonFile); + +// Function to merge xCodeSamples for the same path and method +const mergeCodeSamples = (powershellData, pythonData) => { + // Create a map to keep track of paths and methods, and merged samples + const mergedData = {}; + + // Iterate over both files + [powershellData, pythonData].forEach(fileData => { + fileData.forEach(item => { + const path = item.path; + const method = item.method; + + // Initialize the path and method if not already in mergedData + if (!mergedData[path]) { + mergedData[path] = {}; + } + + if (!mergedData[path][method]) { + mergedData[path][method] = { + path: item.path, + method: item.method, + xCodeSample: [] + }; + } + + // Add the xCodeSample data, if it exists + if (item.xCodeSample) { + mergedData[path][method].xCodeSample.push(...item.xCodeSample); + } + }); + }); + + // Convert the merged data back to an array format (flatten the structure) + const mergedArray = []; + Object.keys(mergedData).forEach(path => { + Object.keys(mergedData[path]).forEach(method => { + mergedArray.push(mergedData[path][method]); + }); + }); + + return mergedArray; +}; + +// Merge the data +const mergedCode = mergeCodeSamples(powershellData, pythonData); + +// Convert the merged data to YAML format with lineWidth: -1 to avoid block-style strings +const mergedYaml = yaml.dump(mergedCode, { + lineWidth: -1 // Avoid wrapping strings into block-style format +}); + +// Derive the output directory and file name +const pythonFileDir = path.dirname(pythonFilePath); +const powershellFileDir = path.dirname(powershellFilePath); + +// Find the common directory (use the Python file's directory as the base) +const commonDir = pythonFileDir; + +// Create the output file path +const outputFilePath = path.join(commonDir, 'merged_code_examples.yaml'); + +// Write the merged result to the output file +fs.writeFileSync(outputFilePath, mergedYaml, 'utf8'); + +console.log(`Merged YAML file has been saved to ${outputFilePath}`); diff --git a/src/theme/ApiExplorer/CodeSnippets/languages.ts b/src/theme/ApiExplorer/CodeSnippets/languages.ts index 04f34cbbb..524d52939 100644 --- a/src/theme/ApiExplorer/CodeSnippets/languages.ts +++ b/src/theme/ApiExplorer/CodeSnippets/languages.ts @@ -93,7 +93,7 @@ export function generateLanguageSet() { }, variant: variants[0], variants: variants, - tag: language.key === 'powershell' ? 'sailpoint-sdk' : '', // Only add the "sailpoint-sdk" tag for PowerShell + tag: language.key === 'powershell' || language.key === 'python' ? 'sailpoint-sdk' : '', // Only add the "sailpoint-sdk" tag for PowerShell or Python }); }); diff --git a/static/code-examples/beta/beta.yaml b/static/code-examples/beta/beta.yaml index a15e39827..9b8233f46 100644 --- a/static/code-examples/beta/beta.yaml +++ b/static/code-examples/beta/beta.yaml @@ -1711,6 +1711,7 @@ components: description: Name of the Object type: string example: aName + nullable: true created: description: Creation date of the Object type: string @@ -2747,6 +2748,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + 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 + + api_response = api_instance.list_access_model_metadata_attribute() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute(filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(api_response) + 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 @@ -2806,6 +2822,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + try: + # Get Access Model Metadata Attribute + + api_response = api_instance.get_access_model_metadata_attribute(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute(key) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(api_response) + 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 @@ -2879,6 +2910,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + try: + # List Access Model Metadata Values + + api_response = api_instance.list_access_model_metadata_attribute_value(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute_value(key) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(api_response) + 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 @@ -2947,6 +2993,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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. + try: + # Get Access Model Metadata Value + + api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) /access-profiles: get: operationId: listAccessProfiles @@ -3355,6 +3417,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* 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* 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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) post: operationId: createAccessProfile tags: @@ -3501,6 +3585,105 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) /access-profiles/{id}: get: operationId: getAccessProfile @@ -3570,6 +3753,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) patch: operationId: patchAccessProfile tags: @@ -3731,6 +3929,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) delete: operationId: deleteAccessProfile tags: @@ -3823,6 +4043,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) /access-profiles/bulk-delete: post: operationId: deleteAccessProfilesInBulk @@ -3981,6 +4214,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) /access-profiles/bulk-update-requestable: post: operationId: updateAccessProfilesInBulk @@ -4128,6 +4379,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#update-access-profiles-in-bulk + source: | + [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + + try: + # Update Access Profile(s) requestable field. + Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + api_response = api_instance.update_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) /access-profiles/{id}/entitlements: get: operationId: getAccessProfileEntitlements @@ -4415,6 +4683,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) /access-requests: post: operationId: createAccessRequest @@ -4584,7 +4872,8 @@ paths: description: The id of the access item requested. example: 779c6fd7171540bba1184e5946112c28 attributesHash: - type: string + type: integer + format: int32 description: a hash representation of the access requested, useful for longer term tracking client side. example: -1928438224 accessRequestIds: @@ -4704,6 +4993,74 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) /access-requests/cancel: post: operationId: cancelAccessRequest @@ -4802,6 +5159,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) /access-requests/close: post: operationId: closeAccessRequest @@ -4914,6 +5289,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#close-access-request + source: | + close_access_request = { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } # CloseAccessRequest | + try: + # Close Access Request + Result = close_access_request.from_json(close_access_request) + api_response = api_instance.close_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.close_access_request(Result) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) /access-request-config: get: operationId: getAccessRequestConfig @@ -5043,6 +5438,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) put: operationId: setAccessRequestConfig security: @@ -5129,6 +5538,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) /access-request-status: get: operationId: listAccessRequestStatus @@ -5850,6 +6299,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) /access-request-approvals/pending: get: operationId: listPendingApprovals @@ -6194,6 +6667,15 @@ paths: type: string description: SOD policy display name. example: Business SOD Policy + 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 '401': $ref: '#/paths/~1access-model-metadata~1attributes/get/responses/401' x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml @@ -6228,6 +6710,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-pending-approvals + source: | + owner_id = 'owner_id_example' # 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 = '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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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* (optional) + 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: **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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) /access-request-approvals/completed: get: operationId: listCompletedApprovals @@ -6472,6 +6974,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-completed-approvals + source: | + owner_id = 'owner_id_example' # 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 = '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: **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 = '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: **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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) /access-request-approvals/{approvalId}/approve: post: operationId: approveAccessRequest @@ -6574,6 +7096,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#approve-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + try: + # Approve Access Request Approval + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.approve_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) /access-request-approvals/{approvalId}/reject: post: operationId: rejectAccessRequest @@ -6649,6 +7195,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#reject-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) /access-request-approvals/{approvalId}/forward: post: operationId: forwardAccessRequest @@ -6732,6 +7302,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#forward-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + forward_approval_dto = { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) /access-request-approvals/approval-summary: get: operationId: getAccessRequestApprovalSummary @@ -6815,6 +7404,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) /ai-access-request-recommendations: get: operationId: getAccessRequestRecommendations @@ -6986,6 +7591,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + 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 = '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: **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 + + api_response = api_instance.get_access_request_recommendations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) /ai-access-request-recommendations/ignored-items: post: operationId: addAccessRequestRecommendationsIgnoredItem @@ -7081,6 +7707,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + 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: + # Notification of Ignored Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_ignored_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_ignored_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsIgnoredItems tags: @@ -7165,6 +7812,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + 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) + 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 of Ignored Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_ignored_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") + pprint(api_response) + 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 @@ -7229,6 +7895,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + 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: + # Notification of Requested Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_requested_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_requested_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsRequestedItems tags: @@ -7312,6 +7999,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + 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) + 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 = '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: **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 of Requested Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_requested_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") + pprint(api_response) + 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 @@ -7376,6 +8082,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + 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: + # Notification of Viewed Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsViewedItems tags: @@ -7459,6 +8186,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + 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) + 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 = '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: **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 of Viewed Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_viewed_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") + pprint(api_response) + 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 @@ -7526,6 +8272,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + try: + # Notification of Viewed Access Request Recommendations in Bulk + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_items(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_items(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) /accounts: get: operationId: listAccounts @@ -7861,6 +8630,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#list-accounts + source: | + 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) + 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* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.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, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + try: + # Accounts List + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(detail_level, limit, offset, count, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) post: operationId: createAccount tags: @@ -7972,6 +8761,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) /accounts/{id}: get: operationId: getAccount @@ -8037,6 +8850,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) patch: operationId: updateAccount tags: @@ -8147,6 +8975,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#update-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Account + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) put: operationId: putAccount tags: @@ -8245,6 +9091,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) delete: operationId: deleteAccount tags: @@ -8311,6 +9181,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) /accounts/{id}/entitlements: get: operationId: getAccountEntitlements @@ -8386,6 +9271,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#get-account-entitlements + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + 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: + # Account Entitlements + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, offset, limit, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) /accounts/{id}/reload: post: operationId: submitReloadAccount @@ -8450,6 +9353,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) /accounts/{id}/enable: post: operationId: enableAccount @@ -8537,6 +9455,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) /accounts/{id}/disable: post: operationId: disableAccount @@ -8615,6 +9552,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) /accounts/{id}/unlock: post: operationId: unlockAccount @@ -8709,6 +9665,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) /accounts/{id}/remove: post: operationId: deleteAccountAsync @@ -8794,6 +9770,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#delete-account-async + source: | + id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id + try: + # Remove Account + + api_response = api_instance.delete_account_async(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account_async(id) + print("The response of AccountsApi->delete_account_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) /identities-accounts/{id}/enable: post: operationId: enableAccountForIdentity @@ -8855,6 +9846,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-account-for-identity + source: | + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + try: + # Enable IDN Account for Identity + + api_response = api_instance.enable_account_for_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account_for_identity(id) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) /identities-accounts/{id}/disable: post: operationId: disableAccountForIdentity @@ -8916,6 +9922,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-account-for-identity + source: | + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + try: + # Disable IDN Account for Identity + + api_response = api_instance.disable_account_for_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account_for_identity(id) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) /identities-accounts/enable: post: operationId: enableAccountsForIdentities @@ -9012,6 +10033,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-accounts-for-identities + source: | + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + try: + # Enable IDN Accounts for Identities + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.enable_accounts_for_identities(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_accounts_for_identities(Result) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) /identities-accounts/disable: post: operationId: disableAccountsForIdentities @@ -9086,6 +10124,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-accounts-for-identities + source: | + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + try: + # Disable IDN Accounts for Identities + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.disable_accounts_for_identities(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_accounts_for_identities(Result) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) /accounts/search-attribute-config: post: operationId: createSearchAttributeConfig @@ -9171,6 +10226,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + search_attribute_config = { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } # SearchAttributeConfig | + try: + # Create Extended Search Attributes + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) get: operationId: getSearchAttributeConfig tags: @@ -9217,6 +10294,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + try: + # List Extended Search Attributes + + api_response = api_instance.get_search_attribute_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) /accounts/search-attribute-config/{name}: get: operationId: getSingleSearchAttributeConfig @@ -9283,6 +10374,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + api_response = api_instance.get_single_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) delete: operationId: deleteSearchAttributeConfig security: @@ -9339,6 +10445,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) patch: operationId: patchSearchAttributeConfig security: @@ -9432,6 +10551,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) /account-activities: get: operationId: listAccountActivities @@ -9774,6 +10915,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-activities#list-account-activities + source: | + requested_for = 'requested_for_example' # 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 = 'requested_by_example' # 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 = 'regarding_identity_example' # 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) + type = 'type_example' # str | The type of account activity. (optional) # str | The type of account activity. (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 = '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: **type**: *eq, in, ge, gt, 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, gt, 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 = '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: **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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) /account-activities/{id}: get: operationId: getAccountActivity @@ -9833,6 +10997,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) /account-aggregations/{id}/status: get: operationId: getAccountAggregationStatus @@ -9933,6 +11112,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-aggregations#get-account-aggregation-status + source: | + id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id + try: + # In-progress Account Aggregation status + + api_response = api_instance.get_account_aggregation_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_aggregation_status(id) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) /auth-profiles: get: operationId: getProfileConfigList @@ -9992,6 +11186,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config-list + source: | + try: + # Get list of Auth Profiles. + + api_response = api_instance.get_profile_config_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config_list() + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) /auth-profiles/{id}: get: operationId: getProfileConfig @@ -10090,6 +11298,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get. + try: + # Get Auth Profile. + + api_response = api_instance.get_profile_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config(id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) patch: operationId: patchProfileConfig tags: @@ -10166,6 +11389,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#patch-profile-config + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Auth Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_profile_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_profile_config(id, Result) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) /campaigns: get: operationId: getActiveCampaigns @@ -10665,6 +11910,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) post: operationId: createCampaign tags: @@ -11078,6 +12343,129 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign + source: | + 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 Campaign + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) /campaigns/delete: post: operationId: deleteCampaigns @@ -11152,6 +12540,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaigns + source: | + delete_campaigns_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # DeleteCampaignsRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = delete_campaigns_request.from_json(delete_campaigns_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) /campaigns/{id}: get: operationId: getCampaign @@ -11265,6 +12670,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. + try: + # Get Campaign + + api_response = api_instance.get_campaign(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) patch: operationId: updateCampaign tags: @@ -11377,6 +12797,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign being modified. # str | ID of the campaign being modified. + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) /campaigns/{id}/activate: post: operationId: startCampaign @@ -11457,6 +12895,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) /campaigns/{id}/complete: post: operationId: completeCampaign @@ -11549,6 +13005,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#complete-campaign + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. + complete_campaign_options = { + "autoCompleteAction" : "REVOKE" + } # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) /campaigns/{id}/run-remediation-scan: post: operationId: startCampaignRemediationScan @@ -11611,6 +13085,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) /campaigns/{id}/reassign: post: security: @@ -11775,6 +13264,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) /campaigns/{id}/reports: get: operationId: getCampaignReports @@ -11866,6 +13378,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) /campaigns/{id}/run-report/{type}: post: operationId: startCampaignReport @@ -11942,6 +13469,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign-report + source: | + 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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of report to run. + try: + # Run Campaign Report + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) /campaigns/reports-configuration: get: operationId: getCampaignReportsConfig @@ -12006,6 +13549,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) put: operationId: setCampaignReportsConfig tags: @@ -12072,6 +13629,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) /campaign-templates: get: operationId: getCampaignTemplates @@ -12400,6 +13974,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) post: operationId: createCampaignTemplate tags: @@ -12841,6 +14434,144 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign-template + source: | + 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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) /campaign-templates/{id}: get: operationId: getCampaignTemplate @@ -12921,6 +14652,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) patch: operationId: patchCampaignTemplate tags: @@ -13030,6 +14776,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) delete: operationId: deleteCampaignTemplate tags: @@ -13091,6 +14859,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) /campaign-templates/{id}/generate: post: operationId: startGenerateCampaignTemplate @@ -13216,6 +14997,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) /campaign-templates/{id}/schedule: get: operationId: getCampaignTemplateSchedule @@ -13440,6 +15236,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) put: operationId: setCampaignTemplateSchedule tags: @@ -13596,6 +15407,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) delete: operationId: deleteCampaignTemplateSchedule tags: @@ -13656,6 +15500,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) /certifications/{id}/reassign-async: post: operationId: submitReassignCertsAsync @@ -13797,6 +15654,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) /certifications/{id}/tasks/{taskId}: get: operationId: getIdentityCertificationTaskStatus @@ -13863,6 +15746,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-task-status + source: | + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID + try: + # Certification Task Status + + api_response = api_instance.get_identity_certification_task_status(id, task_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_task_status(id, task_id) + print("The response of CertificationsApi->get_identity_certification_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) /certifications/{id}/tasks-pending: get: operationId: getIdentityCertificationPendingTasks @@ -13923,6 +15822,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-pending-tasks + source: | + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Pending Certification Tasks + + api_response = api_instance.get_identity_certification_pending_tasks(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_pending_tasks(id) + print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) /certifications/{certificationId}/access-review-items/{itemId}/permissions: get: operationId: getIdentityCertificationItemPermissions @@ -14041,6 +15955,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-item-permissions + source: | + 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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) /certifications/{id}/reviewers: get: operationId: listCertificationReviewers @@ -14159,6 +16093,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) /certifications: get: operationId: listCertifications @@ -14386,6 +16340,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertifications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#list-certifications + source: | + reviewer_identitiy = 'reviewer_identitiy_example' # 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 = '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: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + 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: **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: + # Certifications by IDs + + api_response = api_instance.list_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) /connector-rules: get: tags: @@ -14461,6 +16435,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule-list + source: | + try: + # List Connector Rules + + api_response = api_instance.get_connector_rule_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule_list() + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) post: tags: - Connector Rule Management @@ -14627,6 +16615,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#create-connector-rule + source: | + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | The connector rule to create + try: + # Create Connector Rule + Result = connector_rule_create_request.from_json(connector_rule_create_request) + api_response = api_instance.create_connector_rule(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_connector_rule(Result) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) /connector-rules/{id}: get: tags: @@ -14694,6 +16722,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve + try: + # Connector-Rule by ID + + api_response = api_instance.get_connector_rule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule(id) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) put: tags: - Connector Rule Management @@ -14805,6 +16848,48 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#update-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + try: + # Update a Connector Rule + + api_response = api_instance.update_connector_rule(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector_rule(id, Result) + print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) delete: tags: - Connector Rule Management @@ -14866,6 +16951,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#delete-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete # str | ID of the connector rule to delete + try: + # Delete a Connector-Rule + + api_instance.delete_connector_rule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_connector_rule(id) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) /connector-rules/validate: post: tags: @@ -14977,6 +17075,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#validate-connector-rule + source: | + source_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | The code to validate + try: + # Validate Connector Rule + Result = source_code.from_json(source_code) + api_response = api_instance.validate_connector_rule(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.validate_connector_rule(Result) + print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) /connectors: get: tags: @@ -15139,6 +17255,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connectors#get-connector-list + source: | + 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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) /custom-password-instructions: post: operationId: createCustomPasswordInstructions @@ -15229,6 +17364,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#create-custom-password-instructions + source: | + 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 + Result = custom_password_instruction.from_json(custom_password_instruction) + api_response = api_instance.create_custom_password_instructions(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_password_instructions(Result) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) /custom-password-instructions/{pageId}: get: operationId: getCustomPasswordInstructions @@ -15304,6 +17458,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#get-custom-password-instructions + source: | + page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. + 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 + + api_response = api_instance.get_custom_password_instructions(page_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_password_instructions(page_id, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) delete: operationId: deleteCustomPasswordInstructions tags: @@ -15370,6 +17540,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#delete-custom-password-instructions + source: | + page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. + 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 + + api_instance.delete_custom_password_instructions(page_id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_custom_password_instructions(page_id, locale) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) /entitlements: get: operationId: listEntitlements @@ -15523,6 +17707,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlements + source: | + 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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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. + + api_response = api_instance.list_entitlements() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) /entitlements/{id}: get: operationId: getEntitlement @@ -15618,6 +17825,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement + source: | + id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID + try: + # Get an entitlement + + api_response = api_instance.get_entitlement(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement(id) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) patch: operationId: patchEntitlement tags: @@ -15756,6 +17978,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#patch-entitlement + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch an entitlement + + api_response = api_instance.patch_entitlement(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_entitlement(id, Result) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) /entitlements/{id}/parents: get: operationId: listEntitlementParents @@ -15907,6 +18151,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-parents + source: | + id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement 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 = '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 + + api_response = api_instance.list_entitlement_parents(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_parents(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) /entitlements/{id}/children: get: operationId: listEntitlementChildren @@ -16057,6 +18321,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-children + source: | + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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 = '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 + + api_response = api_instance.list_entitlement_children(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_children(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) /entitlements/bulk-update: post: operationId: updateEntitlementsInBulk @@ -16171,6 +18455,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#update-entitlements-in-bulk + source: | + 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 + Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + api_instance.update_entitlements_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.update_entitlements_in_bulk(Result) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) /entitlements/{id}/entitlement-request-config: get: operationId: getEntitlementRequestConfig @@ -16289,6 +18597,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement-request-config + source: | + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id + try: + # Get Entitlement Request Config + + api_response = api_instance.get_entitlement_request_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_request_config(id) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) put: operationId: putEntitlementRequestConfig tags: @@ -16386,6 +18709,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#put-entitlement-request-config + source: | + id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID + 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 + } + } # EntitlementRequestConfig | + try: + # Replace Entitlement Request Config + Result = entitlement_request_config.from_json(entitlement_request_config) + api_response = api_instance.put_entitlement_request_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_entitlement_request_config(id, Result) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) /entitlements/reset/sources/{sourceId}: post: operationId: resetSourceEntitlements @@ -16459,6 +18810,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#reset-source-entitlements + source: | + source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset + try: + # Reset Source Entitlements + + api_response = api_instance.reset_source_entitlements(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reset_source_entitlements(source_id) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(api_response) + 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. @@ -16536,6 +18902,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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. + try: + # Add metadata to an entitlement. + + api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") + pprint(api_response) + 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. @@ -16607,6 +18990,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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. + try: + # Remove metadata from an entitlement. + + api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + except Exception as e: + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) /entitlements/aggregate/sources/{id}: post: tags: @@ -16733,6 +19131,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#import-entitlements-by-source + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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 + + api_response = api_instance.import_entitlements_by_source(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_by_source(id, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) /generate-password-reset-token/digit: post: operationId: createDigitToken @@ -16826,6 +19240,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#create-digit-token + source: | + password_digit_token_reset = { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } # PasswordDigitTokenReset | + try: + # Generate a digit token + Result = password_digit_token_reset.from_json(password_digit_token_reset) + api_response = api_instance.create_digit_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_digit_token(Result) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) /historical-identities: get: operationId: listHistoricalIdentities @@ -16933,6 +19366,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-historical-identities + source: | + 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 + + api_response = api_instance.list_historical_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) + print("The response of IdentityHistoryApi->list_historical_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) /historical-identities/{id}: get: operationId: getHistoricalIdentity @@ -17030,6 +19482,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + try: + # Get latest snapshot of identity + + api_response = api_instance.get_historical_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity(id) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) /historical-identities/{id}/access-items: get: operationId: listIdentityAccessItems @@ -17418,6 +19885,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-access-items + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + filters = 'source eq \"DataScienceDataset\"' # 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + query = 'Dr. Arden' # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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 + + api_response = api_instance.list_identity_access_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) /historical-identities/{id}/snapshots: get: operationId: listIdentitySnapshots @@ -17505,6 +19994,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshots + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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 + + api_response = api_instance.list_identity_snapshots(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshots(id, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) /historical-identities/{id}/snapshot-summary: get: operationId: getIdentitySnapshotSummary @@ -17604,6 +20113,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot-summary + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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 + + api_response = api_instance.get_identity_snapshot_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) + print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) /historical-identities/{id}/snapshots/{date}: get: operationId: getIdentitySnapshot @@ -17668,6 +20198,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot + source: | + 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 + try: + # Gets an identity snapshot at a given date + + api_response = api_instance.get_identity_snapshot(id, var_date) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot(id, var_date) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(api_response) + 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 @@ -17810,6 +20356,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshot-access-items + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID. + var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date. + type = 'account' # str | Access item type. (optional) # str | Access item type. (optional) + try: + # Get Identity Access Items Snapshot + + api_response = api_instance.list_identity_snapshot_access_items(id, var_date, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) /common-access: get: operationId: getCommonAccess @@ -17954,6 +20517,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#get-common-access + source: | + 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 + + api_response = api_instance.get_common_access() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_common_access(offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) post: operationId: createCommonAccess summary: Create common access items @@ -18046,6 +20628,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#create-common-access + source: | + 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 + Result = common_access_item_request.from_json(common_access_item_request) + api_response = api_instance.create_common_access(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_common_access(Result) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) /common-access/update-status: post: operationId: updateCommonAccessStatusInBulk @@ -18116,6 +20723,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#update-common-access-status-in-bulk + source: | + [sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + try: + # Bulk update common access status + Result = common_access_id_status.from_json(common_access_id_status) + api_response = api_instance.update_common_access_status_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_common_access_status_in_bulk(Result) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(api_response) + 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 @@ -18707,6 +21334,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity-events + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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) + + 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 + + api_response = api_instance.get_historical_identity_events(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->get_historical_identity_events:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) /historical-identities/{id}/start-date: get: operationId: getIdentityStartDate @@ -18763,6 +21415,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-start-date + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + try: + # Gets the start date of the identity + + api_response = api_instance.get_identity_start_date(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_start_date(id) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) /historical-identities/{id}/compare: get: operationId: compareIdentitySnapshots @@ -18870,6 +21537,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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 + + api_response = api_instance.compare_identity_snapshots(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) /historical-identities/{id}/compare/{accessType}: get: operationId: compareIdentitySnapshotsAccessType @@ -18991,6 +21681,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 + 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 + + api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) /identities/{identityId}/synchronize-attributes: post: operationId: synchronizeAttributesForIdentity @@ -19086,6 +21798,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#synchronize-attributes-for-identity + source: | + identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id + try: + # Attribute synchronization for single identity. + + api_response = api_instance.synchronize_attributes_for_identity(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.synchronize_attributes_for_identity(identity_id) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) /identities/{identityId}/ownership: get: operationId: getIdentityOwnershipDetails @@ -19193,6 +21920,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-identity-ownership-details + source: | + identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. + try: + # Get ownership details + + api_response = api_instance.get_identity_ownership_details(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_ownership_details(identity_id) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) /identities: get: operationId: listIdentities @@ -19430,6 +22172,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#list-identities + source: | + 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 + + api_response = api_instance.list_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identities(filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) /identities/{id}: get: operationId: getIdentity @@ -19493,6 +22255,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-identity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Identity Details + + api_response = api_instance.get_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity(id) + print("The response of IdentitiesApi->get_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) delete: operationId: deleteIdentity tags: @@ -19586,6 +22363,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#delete-identity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Delete identity + + api_instance.delete_identity(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity(id) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) /identities/invite: post: operationId: startIdentitiesInvite @@ -19895,6 +22685,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#start-identities-invite + source: | + invite_identities_request = { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } # InviteIdentitiesRequest | + try: + # Invite identities to register + Result = invite_identities_request.from_json(invite_identities_request) + api_response = api_instance.start_identities_invite(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identities_invite(Result) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) /identities/{id}/verification/account/send: post: operationId: sendIdentityVerificationAccountToken @@ -19984,6 +22792,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#send-identity-verification-account-token + source: | + 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 + Result = send_account_verification_request.from_json(send_account_verification_request) + api_instance.send_identity_verification_account_token(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_identity_verification_account_token(id, Result) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) /identities/process: post: operationId: startIdentityProcessing @@ -20082,6 +22907,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#start-identity-processing + source: | + process_identities_request = { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } # ProcessIdentitiesRequest | + try: + # Process a list of identityIds + Result = process_identities_request.from_json(process_identities_request) + api_response = api_instance.start_identity_processing(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identity_processing(Result) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) /identities/{identityId}/reset: post: operationId: resetIdentity @@ -20139,6 +22981,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#reset-identity + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Reset an identity + + api_instance.reset_identity(identity_id) + + # Below is a request that includes all optional parameters + # api_instance.reset_identity(identity_id) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) /identities/{identityId}/role-assignments: get: operationId: getRoleAssignments @@ -20357,6 +23212,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignments + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for + 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 + + api_response = api_instance.get_role_assignments(identity_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignments(identity_id, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) /identities/{identityId}/role-assignments/{assignmentId}: get: operationId: getRoleAssignment @@ -20427,6 +23299,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignment + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id + try: + # Role assignment details + + api_response = api_instance.get_role_assignment(identity_id, assignment_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignment(identity_id, assignment_id) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) /identity-attributes: get: operationId: listIdentityAttributes @@ -20560,6 +23448,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#list-identity-attributes + source: | + 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 + + api_response = api_instance.list_identity_attributes() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_attributes(include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) post: operationId: createIdentityAttribute tags: @@ -20643,6 +23549,42 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#create-identity-attribute + source: | + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.create_identity_attribute(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_attribute(Result) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) /identity-attributes/{name}: get: operationId: getIdentityAttribute @@ -20705,6 +23647,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#get-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + try: + # Get Identity Attribute + + api_response = api_instance.get_identity_attribute(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_attribute(name) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) put: operationId: putIdentityAttribute tags: @@ -20798,6 +23755,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#put-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.put_identity_attribute(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_identity_attribute(name, Result) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) delete: operationId: deleteIdentityAttribute tags: @@ -20855,6 +23849,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + try: + # Delete Identity Attribute + + api_instance.delete_identity_attribute(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attribute(name) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) /identity-attributes/bulk-delete: delete: operationId: deleteIdentityAttributesInBulk @@ -20926,6 +23933,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + identity_attribute_names = { + "ids" : [ "name", "displayName" ] + } # IdentityAttributeNames | + try: + # Bulk delete Identity Attributes + Result = identity_attribute_names.from_json(identity_attribute_names) + api_instance.delete_identity_attributes_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attributes_in_bulk(Result) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) /identity-profiles: get: operationId: listIdentityProfiles @@ -21093,6 +24115,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#list-identity-profiles + 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) + filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) post: operationId: createIdentityProfile summary: Create Identity Profile @@ -21204,6 +24245,69 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#create-identity-profile + source: | + identity_profile = { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "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" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } # IdentityProfile | + try: + # Create Identity Profile + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) /identity-profiles/bulk-delete: post: operationId: deleteIdentityProfiles @@ -21313,6 +24417,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) /identity-profiles/export: get: operationId: exportIdentityProfiles @@ -21424,6 +24545,7 @@ paths: description: Name of the Object type: string example: aName + nullable: true created: description: Creation date of the Object type: string @@ -21591,6 +24713,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#export-identity-profiles + 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) + filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) /identity-profiles/import: post: operationId: importIdentityProfiles @@ -21787,6 +24928,79 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) /identity-profiles/identity-preview: post: operationId: showGenerateIdentityPreview @@ -21923,6 +25137,47 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#show-generate-identity-preview + source: | + 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.show_generate_identity_preview(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_generate_identity_preview(Result) + print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) /identity-profiles/{identity-profile-id}: get: operationId: getIdentityProfile @@ -21991,6 +25246,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) delete: operationId: deleteIdentityProfile tags: @@ -22058,6 +25328,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) patch: operationId: updateIdentityProfile tags: @@ -22162,6 +25447,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) /identity-profiles/{identity-profile-id}/default-identity-attribute-config: get: operationId: getDefaultIdentityAttributeConfig @@ -22227,6 +25534,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID + try: + # Default identity attribute config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) /identity-profiles/{identity-profile-id}/process-identities: post: operationId: syncIdentityProfile @@ -22296,6 +25618,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}: get: operationId: getLifecycleStates @@ -22462,6 +25799,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) patch: operationId: updateLifecycleStates tags: @@ -22580,6 +25933,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) /multihosts: post: tags: @@ -23025,6 +26401,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-multi-host-integration + source: | + multi_host_integrations_create = { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + try: + # Create Multi-Host Integration + Result = multi_host_integrations_create.from_json(multi_host_integrations_create) + api_response = api_instance.create_multi_host_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_multi_host_integration(Result) + print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) get: tags: - Multi-Host Integration @@ -23135,6 +26551,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations-list + source: | + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *in* **forSubAdminId**: *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: **type**: *in* **forSubAdminId**: *in* (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) + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) + try: + # List All Existing Multi-Host Integrations + + api_response = api_instance.get_multi_host_integrations_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) /multihosts/types: get: tags: @@ -23209,6 +26645,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multihost-integration-types + source: | + try: + # List Multi-Host Integration Types + + api_response = api_instance.get_multihost_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multihost_integration_types() + print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) /multihosts/{multihostId}: post: tags: @@ -23318,6 +26768,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + [sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + multi_host_integrations_create_sources = { + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + } # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + + try: + # Create Sources Within Multi-Host Integration + Result = multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) + api_instance.create_sources_within_multi_host(multihost_id, Result) + + # Below is a request that includes all optional parameters + # api_instance.create_sources_within_multi_host(multihost_id, Result) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) get: tags: - Multi-Host Integration @@ -23385,6 +26862,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + try: + # Get Multi-Host Integration By ID + + api_response = api_instance.get_multi_host_integrations(multihost_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_integrations(multihost_id) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) delete: tags: - Multi-Host Integration @@ -23447,6 +26939,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#delete-multi-host + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. + try: + # Delete Multi-Host Integration + + api_instance.delete_multi_host(multihost_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_multi_host(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) patch: operationId: updateMultiHostSources tags: @@ -23571,6 +27076,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#update-multi-host-sources + source: | + multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. + [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + + try: + # Update Multi-Host Integration + Result = update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) + api_instance.update_multi_host_sources(multihost_id, Result) + + # Below is a request that includes all optional parameters + # api_instance.update_multi_host_sources(multihost_id, Result) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) /multihosts/{multihostId}/sources/testConnection: post: tags: @@ -23634,6 +27155,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-connection-multi-host-sources + source: | + multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + try: + # Test Configuration For Multi-Host Integration + + api_instance.test_connection_multi_host_sources(multihost_id) + + # Below is a request that includes all optional parameters + # api_instance.test_connection_multi_host_sources(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) /multihosts/{multihostId}/sources/{sourceId}/testConnection: get: tags: @@ -23744,6 +27278,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-source-connection-multihost + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration + try: + # Test Configuration For Multi-Host Integration's Single Source + + api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) /multihosts/{multihostId}/sources: get: tags: @@ -24245,6 +27795,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-sources-within-multi-host + source: | + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *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**: *in* (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) + try: + # List Sources Within Multi-Host Integration + + api_response = api_instance.get_sources_within_multi_host(multihost_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) + print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) /multihosts/{multiHostId}/sources/errors: get: tags: @@ -24344,6 +27914,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + try: + # List Multi-Host Source Creation Errors + + api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) /multihosts/{multihostId}/acctAggregationGroups: get: tags: @@ -24462,6 +28047,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-acct-aggregation-groups + source: | + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + try: + # Get Account Aggregation Groups Within Multi-Host Integration ID + + api_response = api_instance.get_acct_aggregation_groups(multihost_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_acct_aggregation_groups(multihost_id) + print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) /multihosts/{multiHostId}/entitlementAggregationGroups: get: tags: @@ -24529,6 +28129,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + try: + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) /non-employee-records: post: operationId: createNonEmployeeRecord @@ -24721,6 +28336,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) get: operationId: listNonEmployeeRecords security: @@ -24806,6 +28449,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) /non-employee-records/{id}: get: operationId: getNonEmployeeRecord @@ -24865,6 +28527,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) put: operationId: updateNonEmployeeRecord security: @@ -24951,6 +28628,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) patch: operationId: patchNonEmployeeRecord security: @@ -25034,6 +28740,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # 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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) delete: operationId: deleteNonEmployeeRecord security: @@ -25088,6 +28816,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_record(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) /non-employee-records/bulk-delete: post: operationId: deleteNonEmployeeRecordInBulk @@ -25156,6 +28897,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk + source: | + delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) + api_instance.delete_non_employee_record_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_record_in_bulk(Result) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) /non-employee-requests: post: operationId: createNonEmployeeRequest @@ -25387,6 +29141,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) get: operationId: listNonEmployeeRequests security: @@ -25480,6 +29262,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + requested_for = 'me' # 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 = 'approvalStatus,firstName' # 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) /non-employee-requests/{id}: get: operationId: getNonEmployeeRequest @@ -25542,6 +29344,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) delete: operationId: deleteNonEmployeeRequest security: @@ -25600,6 +29417,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format + try: + # Delete Non-Employee Request + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) /non-employee-requests/summary/{requested-for}: get: operationId: getNonEmployeeRequestSummary @@ -25672,6 +29502,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) /non-employee-sources: post: operationId: createNonEmployeeSource @@ -25807,6 +29652,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) get: operationId: listNonEmployeeSources security: @@ -25909,6 +29794,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) /non-employee-sources/{sourceId}: get: operationId: getNonEmployeeSource @@ -26006,6 +29911,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) patch: operationId: patchNonEmployeeSource security: @@ -26091,6 +30011,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) delete: operationId: deleteNonEmployeeSource security: @@ -26145,6 +30087,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_source(source_id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) /non-employee-sources/{id}/non-employees/download: get: operationId: exportNonEmployeeRecords @@ -26209,6 +30164,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.export_non_employee_records(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) /non-employee-sources/{id}/non-employee-bulk-upload: post: operationId: importNonEmployeeRecordsInBulk @@ -26324,6 +30292,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) /non-employee-sources/{id}/non-employee-bulk-upload/status: get: operationId: getNonEmployeeBulkUploadStatus @@ -26399,6 +30383,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Bulk upload status on source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) /non-employee-sources/{id}/schema-attributes-template/download: get: operationId: exportNonEmployeeSourceSchemaTemplate @@ -26463,6 +30462,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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) /non-employee-approvals: get: operationId: listNonEmployeeApproval @@ -26573,6 +30585,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-approval + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.list_non_employee_approval() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) /non-employee-approvals/{id}: get: operationId: getNonEmployeeApproval @@ -26724,6 +30756,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) /non-employee-approvals/{id}/approve: post: operationId: approveNonEmployeeRequest @@ -26799,6 +30847,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_approval_decision = { + "comment" : "comment" + } # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) /non-employee-approvals/{id}/reject: post: operationId: rejectNonEmployeeRequest @@ -26876,6 +30942,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = { + "comment" : "comment" + } # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) /non-employee-approvals/summary/{requested-for}: get: operationId: getNonEmployeeApprovalSummary @@ -26944,6 +31028,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) /non-employee-sources/{sourceId}/schema-attributes: get: operationId: getNonEmployeeSourceSchemaAttributes @@ -27068,6 +31167,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) post: operationId: createNonEmployeeSourceSchemaAttributes security: @@ -27171,6 +31285,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # 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 Non-Employee Source Schema Attribute + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) delete: operationId: deleteNonEmployeeSourceSchemaAttributes security: @@ -27225,6 +31362,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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) /non-employee-sources/{sourceId}/schema-attributes/{attributeId}: get: operationId: getNonEmployeeSchemaAttribute @@ -27295,6 +31445,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id + try: + # Get Schema Attribute Non-Employee Source + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) patch: operationId: patchNonEmployeeSchemaAttribute security: @@ -27388,6 +31554,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 Non-Employee Source's Schema Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) delete: operationId: deleteNonEmployeeSchemaAttribute security: @@ -27452,6 +31641,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + try: + # Delete Non-Employee Source's Schema Attribute + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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) /managed-clients/{id}/status: get: tags: @@ -27568,6 +31771,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) post: tags: - Managed Clients @@ -27786,6 +32005,47 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = { + "body" : { + "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" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } # ManagedClientStatus | + try: + # Handle status request from client + Result = managed_client_status.from_json(managed_client_status) + api_response = api_instance.update_managed_client_status(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client_status(id, Result) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) /managed-clusters/{id}: get: tags: @@ -28023,6 +32283,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) /managed-clusters/{id}/log-config: get: tags: @@ -28131,6 +32406,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) put: tags: - Managed Clusters @@ -28212,6 +32502,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) /managed-clusters: get: tags: @@ -28287,6 +32599,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + 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: + # Retrieve all Managed Clusters. + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) /mail-from-attributes: put: security: @@ -28387,6 +32717,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#put-mail-from-attributes + source: | + mail_from_attributes_dto = { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } # MailFromAttributesDto | + try: + # Change MAIL FROM domain + Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) + api_response = api_instance.put_mail_from_attributes(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_mail_from_attributes(Result) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) /mail-from-attributes/{identityId}: get: security: @@ -28445,6 +32793,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-mail-from-attributes + source: | + identity_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 + try: + # Get MAIL FROM Attributes + + api_response = api_instance.get_mail_from_attributes(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mail_from_attributes(identity_id) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) /generic-approvals: get: security: @@ -28687,6 +33050,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/approvals#get-approvals + source: | + 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 + + api_response = api_instance.get_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approvals(mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) /generic-approvals/{id}: get: security: @@ -28746,6 +33126,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/approvals#get-approval + source: | + id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned. + try: + # Get Approval + + api_response = api_instance.get_approval(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approval(id) + print("The response of ApprovalsApi->get_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) /mfa/okta-verify/config: get: operationId: getMFAOktaConfig @@ -28829,6 +33224,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) put: operationId: setMFAOktaConfig tags: @@ -28908,6 +33317,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) /mfa/duo-web/config: get: operationId: getMFADuoConfig @@ -29002,6 +33432,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) put: operationId: setMFADuoConfig tags: @@ -29091,6 +33535,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) /mfa/kba/config: get: operationId: getMFAKbaConfig @@ -29194,6 +33663,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) /mfa/kba/config/answers: post: operationId: setMFAKBAConfig @@ -29309,6 +33793,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) /mfa/{method}/test: get: operationId: testMFAConfig @@ -29391,6 +33895,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) /mfa/{method}/delete: delete: operationId: deleteMFAConfig @@ -29461,6 +33980,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#delete-mfa-config + source: | + 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 + + api_response = api_instance.delete_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) /mfa/okta-verify/verify: post: operationId: sendOktaVerifyRequest @@ -29556,6 +34090,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-okta-verify-request + source: | + okta_verification_request = { + "userId" : "example@mail.com" + } # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + Result = okta_verification_request.from_json(okta_verification_request) + api_response = api_instance.send_okta_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_okta_verify_request(Result) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) /mfa/duo-web/verify: post: operationId: sendDuoVerifyRequest @@ -29639,6 +34190,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-duo-verify-request + source: | + duo_verification_request = { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + Result = duo_verification_request.from_json(duo_verification_request) + api_response = api_instance.send_duo_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_duo_verify_request(Result) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) /mfa/{method}/poll: post: operationId: pingVerificationStatus @@ -29732,6 +34301,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#ping-verification-status + source: | + 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 + Result = verification_poll_request.from_json(verification_poll_request) + api_response = api_instance.ping_verification_status(method, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_verification_status(method, Result) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) /mfa/kba/authenticate: post: operationId: sendKbaAnswers @@ -29837,6 +34424,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-kba-answers + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Authenticate KBA provided MFA method + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.send_kba_answers(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_kba_answers(Result) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) /mfa/token/authenticate: post: operationId: sendTokenAuthRequest @@ -29943,6 +34550,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-token-auth-request + source: | + token_auth_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + Result = token_auth_request.from_json(token_auth_request) + api_response = api_instance.send_token_auth_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_token_auth_request(Result) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) /mfa/token/send: post: operationId: createSendToken @@ -30050,6 +34676,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#create-send-token + source: | + send_token_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } # SendTokenRequest | + try: + # Create and send user token + Result = send_token_request.from_json(send_token_request) + api_response = api_instance.create_send_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_send_token(Result) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) /notification-template-defaults: get: operationId: listNotificationTemplateDefaults @@ -30311,6 +34955,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-template-defaults + 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) + 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 + + api_response = api_instance.list_notification_template_defaults() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_template_defaults(limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) /notification-templates: get: operationId: listNotificationTemplates @@ -30463,6 +35124,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-templates + 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) + 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 + + api_response = api_instance.list_notification_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_templates(limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) post: operationId: createNotificationTemplate tags: @@ -30542,6 +35220,38 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-notification-template + source: | + 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 + Result = template_dto.from_json(template_dto) + api_response = api_instance.create_notification_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_notification_template(Result) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) /notification-templates/{id}: get: operationId: getNotificationTemplate @@ -30602,6 +35312,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-notification-template + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template + try: + # Get Notification Template By Id + + api_response = api_instance.get_notification_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notification_template(id) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) /notification-templates/bulk-delete: post: operationId: deleteNotificationTemplatesInBulk @@ -30679,6 +35404,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#delete-notification-templates-in-bulk + source: | + [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) + api_instance.delete_notification_templates_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_notification_templates_in_bulk(Result) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) /oauth-clients: get: operationId: listOauthClients @@ -30881,6 +35625,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) post: operationId: createOauthClient security: @@ -31158,6 +35917,37 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#create-oauth-client + source: | + 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", "http://localhost:67890" ], + "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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) /oauth-clients/{id}: get: operationId: getOauthClient @@ -31221,6 +36011,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) delete: operationId: deleteOauthClient security: @@ -31277,6 +36082,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_oauth_client(id) + except Exception as e: + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) patch: operationId: patchOauthClient security: @@ -31381,6 +36199,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) /org-config: get: operationId: getOrgConfig @@ -31508,6 +36348,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#get-org-config + source: | + try: + # Get Org configuration settings + + api_response = api_instance.get_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_org_config() + print("The response of OrgConfigApi->get_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) patch: operationId: patchOrgConfig tags: @@ -31580,6 +36434,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#patch-org-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Patch an Org configuration property + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_org_config(Result) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) /org-config/valid-time-zones: get: operationId: getValidTimeZones @@ -31640,6 +36515,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#get-valid-time-zones + source: | + try: + # Get list of time zones + + api_response = api_instance.get_valid_time_zones() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_valid_time_zones() + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) /outlier-summaries: get: operationId: getIdentityOutlierSnapshots @@ -31773,6 +36662,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outlier-snapshots + 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) + 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 + + api_response = api_instance.get_identity_outlier_snapshots() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outlier_snapshots(limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) /outlier-summaries/latest: get: operationId: getLatestIdentityOutlierSnapshots @@ -31870,6 +36778,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + 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 + + api_response = api_instance.get_latest_identity_outlier_snapshots() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_latest_identity_outlier_snapshots(type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) /outliers: get: operationId: getIdentityOutliers @@ -32049,6 +36972,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outliers + 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) + 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 + + api_response = api_instance.get_identity_outliers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outliers(limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) /outliers/{outlierId}/contributing-features: get: operationId: getPeerGroupOutliersContributingFeatures @@ -32210,6 +37153,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier 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) + 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 + + api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + pprint(api_response) + 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 @@ -32357,6 +37320,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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 + 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 + + api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) /outliers/ignore: post: operationId: ignoreIdentityOutliers @@ -32423,6 +37407,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#ignore-identity-outliers + source: | + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Ignore + Result = request_body.from_json(request_body) + api_instance.ignore_identity_outliers(Result) + + # Below is a request that includes all optional parameters + # api_instance.ignore_identity_outliers(Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) /outliers/unignore: post: operationId: unIgnoreIdentityOutliers @@ -32489,6 +37488,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#un-ignore-identity-outliers + source: | + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Unignore + Result = request_body.from_json(request_body) + api_instance.un_ignore_identity_outliers(Result) + + # Below is a request that includes all optional parameters + # api_instance.un_ignore_identity_outliers(Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) /outliers/export: get: operationId: exportOutliersZip @@ -32560,6 +37574,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#export-outliers-zip + source: | + 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 + + api_response = api_instance.export_outliers_zip() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_outliers_zip(type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) /outlier-feature-summaries/{outlierFeatureId}: get: operationId: getOutlierContributingFeatureSummary @@ -32687,6 +37716,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id + try: + # Get identity outlier contibuting feature summary + + api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) /password-dictionary: get: operationId: getPasswordDictionary @@ -32769,6 +37813,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) put: operationId: putPasswordDictionary tags: @@ -32860,6 +37918,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) /query-password-info: post: operationId: queryPasswordInfo @@ -32989,6 +38060,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) /set-password: post: operationId: setIdentityPassword @@ -33141,6 +38230,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#set-identity-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_identity_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_identity_password(Result) + print("The response of PasswordManagementApi->set_identity_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) /password-change-status/{id}: get: operationId: getIdentityPasswordChangeStatus @@ -33221,6 +38331,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#get-identity-password-change-status + source: | + id = 'id_example' # str | # str | + try: + # Get Password Change Request Status + + api_response = api_instance.get_identity_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_password_change_status(id) + print("The response of PasswordManagementApi->get_identity_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) /password-sync-groups: get: operationId: getPasswordSyncGroups @@ -33316,6 +38441,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) post: operationId: createPasswordSyncGroup tags: @@ -33397,6 +38539,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) /password-sync-groups/{id}: get: operationId: getPasswordSyncGroup @@ -33468,6 +38632,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) put: operationId: updatePasswordSyncGroup tags: @@ -33563,6 +38742,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) delete: operationId: deletePasswordSyncGroup tags: @@ -33619,6 +38821,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_password_sync_group(id) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) /password-policies/{id}: get: operationId: getPasswordPolicyById @@ -33868,6 +39083,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) put: operationId: setPasswordPolicy tags: @@ -34038,6 +39268,54 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) delete: operationId: deletePasswordPolicy tags: @@ -34097,6 +39375,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_password_policy(id) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) /password-policies: post: operationId: createPasswordPolicy @@ -34226,6 +39517,53 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) get: operationId: listPasswordPolicies tags: @@ -34349,6 +39687,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) /password-org-config: get: operationId: getPasswordOrgConfig @@ -34429,6 +39784,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) put: operationId: putPasswordOrgConfig tags: @@ -34504,6 +39873,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) post: operationId: createPasswordOrgConfig tags: @@ -34581,6 +39970,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) /peer-group-strategies/{strategy}/identity-outliers: get: operationId: getPeerGroupOutliers @@ -34666,6 +40075,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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. + 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 + + api_response = api_instance.get_peer_group_outliers(strategy, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers(strategy, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) /personal-access-tokens: get: operationId: listPersonalAccessTokens @@ -34804,6 +40231,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) post: operationId: createPersonalAccessToken security: @@ -34944,6 +40387,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) /personal-access-tokens/{id}: patch: operationId: patchPersonalAccessToken @@ -35036,6 +40498,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) delete: operationId: deletePersonalAccessToken security: @@ -35093,6 +40577,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_personal_access_token(id) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) /public-identities-config: get: operationId: getPublicIdentityConfig @@ -35177,6 +40674,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get Public Identity Config + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) put: operationId: updatePublicIdentityConfig tags: @@ -35247,6 +40758,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/public-identities-config#update-public-identity-config + source: | + 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 Public Identity Config + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) /notification-template-context: get: operationId: getNotificationsTemplateContext @@ -35324,6 +40864,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-notifications-template-context + source: | + try: + # Get Notification Template Context + + api_response = api_instance.get_notifications_template_context() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notifications_template_context() + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) /notification-preferences/{key}: get: operationId: listNotificationPreferences @@ -35411,6 +40965,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-preferences + source: | + key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key. + try: + # List Notification Preferences for tenant. + + api_response = api_instance.list_notification_preferences(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_preferences(key) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) /reassignment-configurations/types: get: operationId: getReassignmentConfigTypes @@ -35485,6 +41054,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-config-types + source: | + try: + # List Reassignment Config Types + + api_response = api_instance.get_reassignment_config_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_config_types() + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) /reassignment-configurations: get: operationId: listReassignmentConfigurations @@ -35495,6 +41078,29 @@ paths: security: - userAuth: - idn:reassignment-configuration:read + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: query + name: limit + description: Max number of results to return. + required: false + schema: + type: integer + format: int32 + minimum: 0 + maximum: 20 + default: 20 + example: 20 + - in: query + name: offset + description: Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + required: false + schema: + type: integer + format: int32 + minimum: 0 + example: 10 responses: '200': description: A list of Reassignment Configurations for an org @@ -35566,6 +41172,8 @@ paths: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations source: | + $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # List Reassignment Configurations @@ -35573,11 +41181,27 @@ paths: Get-BetaReassignmentConfigurations # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigurations + # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#list-reassignment-configurations + source: | + limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) + 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) + try: + # List Reassignment Configurations + + api_response = api_instance.list_reassignment_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_reassignment_configurations(limit, offset) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) post: operationId: createReassignmentConfiguration tags: @@ -35587,6 +41211,8 @@ paths: security: - userAuth: - idn:reassignment-configuration:create + x-sailpoint-userLevels: + - ORG_ADMIN requestBody: required: true content: @@ -35676,6 +41302,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#create-reassignment-configuration + source: | + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.create_reassignment_configuration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_reassignment_configuration(Result) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) /reassignment-configurations/{identityId}: get: operationId: getReassignmentConfiguration @@ -35738,6 +41385,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + try: + # Get Reassignment Configuration + + api_response = api_instance.get_reassignment_configuration(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_configuration(identity_id) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) put: operationId: putReassignmentConfig tags: @@ -35813,6 +41475,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-reassignment-config + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.put_reassignment_config(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_reassignment_config(identity_id, Result) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) /reassignment-configurations/{identityId}/{configType}: delete: operationId: deleteReassignmentConfiguration @@ -35879,6 +41563,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + try: + # Delete Reassignment Configuration + + api_instance.delete_reassignment_configuration(identity_id, config_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_reassignment_configuration(identity_id, config_type) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) /reassignment-configurations/{identityId}/evaluate/{configType}: get: operationId: getEvaluateReassignmentConfiguration @@ -36030,6 +41728,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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) + + 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 + + api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) /reassignment-configurations/tenant-config: get: operationId: getTenantConfigConfiguration @@ -36113,6 +41830,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + try: + # Get Tenant-wide Reassignment Configuration settings + + api_response = api_instance.get_tenant_config_configuration() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_config_configuration() + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) put: operationId: putTenantConfiguration tags: @@ -36180,6 +41911,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-tenant-configuration + source: | + tenant_configuration_request = { + "configDetails" : { + "disabled" : true + } + } # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + Result = tenant_configuration_request.from_json(tenant_configuration_request) + api_response = api_instance.put_tenant_configuration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tenant_configuration(Result) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) /recommendations/request: post: operationId: getRecommendations @@ -36288,6 +42038,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations + source: | + 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 a Recommendation Based on Object + Result = recommendation_request_dto.from_json(recommendation_request_dto) + api_response = api_instance.get_recommendations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations(Result) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) /recommendations/config: get: operationId: getRecommendationsConfig @@ -36361,6 +42144,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations-config + source: | + try: + # Get certification recommendation config values + + api_response = api_instance.get_recommendations_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations_config() + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) put: operationId: updateRecommendationsConfig summary: Update certification recommendation config values @@ -36421,6 +42218,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#update-recommendations-config + source: | + recommendation_config_dto = { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } # RecommendationConfigDto | + try: + # Update certification recommendation config values + Result = recommendation_config_dto.from_json(recommendation_config_dto) + api_response = api_instance.update_recommendations_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_recommendations_config(Result) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) /requestable-objects: get: operationId: listRequestableObjects @@ -36617,6 +42434,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/requestable-objects#list-requestable-objects + source: | + 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.beta.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. Support for additional types may be added in the future without notice. (optional) + + types = [sailpoint.beta.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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) /role-insights/requests: post: operationId: createRoleInsightRequests @@ -36705,6 +42549,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#create-role-insight-requests + source: | + try: + # Generate insights for roles + + api_response = api_instance.create_role_insight_requests() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_insight_requests() + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) /role-insights/requests/{id}: get: operationId: getRoleInsightsRequests @@ -36762,6 +42620,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-requests + source: | + id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id + try: + # Returns metadata from prior request. + + api_response = api_instance.get_role_insights_requests(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_requests(id) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) /role-insights/summary: get: operationId: getRoleInsightsSummary @@ -36829,6 +42702,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-summary + source: | + try: + # Get role insights summary information + + api_response = api_instance.get_role_insights_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_summary() + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) /role-insights: get: operationId: getRoleInsights @@ -36979,6 +42866,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights + source: | + 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 + + api_response = api_instance.get_role_insights() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights(offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) /role-insights/{insightId}: get: operationId: getRoleInsight @@ -37032,6 +42938,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insight + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + try: + # Get a single role insight + + api_response = api_instance.get_role_insight(insight_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insight(insight_id) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) /role-insights/{insightId}/entitlement-changes: get: operationId: getRoleInsightsEntitlementsChanges @@ -37137,6 +43058,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-entitlements-changes + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.get_role_insights_entitlements_changes(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(api_response) + 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 @@ -37221,6 +43159,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#download-role-insights-entitlements-changes + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.download_role_insights_entitlements_changes(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(api_response) + 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 @@ -37318,6 +43273,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-current-entitlements + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.get_role_insights_current_entitlements(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_current_entitlements(insight_id, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(api_response) + 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 @@ -37447,6 +43418,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-entitlement-changes-identities + source: | + 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 + 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) + + api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) /role-mining-sessions: post: operationId: createRoleMiningSessions @@ -37737,6 +43730,52 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-role-mining-sessions + source: | + 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 + Result = role_mining_session_dto.from_json(role_mining_session_dto) + api_response = api_instance.create_role_mining_sessions(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_mining_sessions(Result) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(api_response) + 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 @@ -37819,6 +43858,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-sessions + source: | + 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 + + api_response = api_instance.get_role_mining_sessions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_sessions(filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) /role-mining-sessions/{sessionId}: patch: operationId: patchRoleMiningSession @@ -37907,6 +43965,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-session + source: | + 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 + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role_mining_session(session_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_session(session_id, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(api_response) + 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 @@ -37965,6 +44045,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session + source: | + 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. + try: + # Get a role mining session + + api_response = api_instance.get_role_mining_session(session_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) /role-mining-sessions/{sessionId}/status: get: operationId: getRoleMiningSessionStatus @@ -38029,6 +44124,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session-status + source: | + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + try: + # Get role mining session status state + + api_response = api_instance.get_role_mining_session_status(session_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session_status(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(api_response) + 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 @@ -38291,6 +44401,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-summaries + source: | + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + 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: + # Retrieve session's potential role summaries + + api_response = api_instance.get_potential_role_summaries(session_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") + pprint(api_response) + 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 @@ -38464,6 +44594,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role + source: | + 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 + try: + # Retrieve potential role in session + + api_response = api_instance.get_potential_role(session_id, potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) patch: operationId: patchPotentialRole summary: Update a potential role in session @@ -38582,6 +44728,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-potential-role + source: | + 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 + [{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] | + 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 in session + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(api_response) + 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 @@ -38686,6 +44851,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-applications + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") + pprint(api_response) + 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 @@ -38790,6 +44975,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") + pprint(api_response) + 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 @@ -38969,6 +45174,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") + pprint(api_response) + 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 @@ -39041,6 +45268,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) + print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") + pprint(api_response) + 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 @@ -39131,6 +45375,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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 + 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 + Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(api_response) + 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 @@ -39249,6 +45513,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-identities-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") + pprint(api_response) + 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 @@ -39311,6 +45596,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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 + try: + # Export (download) details for a potential role in a role mining session + + api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") + pprint(api_response) + 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 @@ -39416,6 +45717,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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 + 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 + + api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(api_response) + 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 @@ -39490,6 +45811,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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 + try: + # Retrieve status of a potential role export job + + api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + pprint(api_response) + 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 @@ -39564,6 +45902,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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 + try: + # Export (download) details for a potential role in a role mining session + + api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + pprint(api_response) + 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 @@ -39689,6 +46044,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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 + 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. + + api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, Result) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(api_response) + 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 @@ -39792,6 +46172,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) /role-mining-potential-roles: get: operationId: getAllPotentialRoleSummaries @@ -39905,6 +46306,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-all-potential-role-summaries + source: | + 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 + + api_response = api_instance.get_all_potential_role_summaries() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_all_potential_role_summaries(sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") + pprint(api_response) + 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 @@ -39963,6 +46383,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-potential-role + source: | + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id + try: + # Retrieves a specific potential role + + api_response = api_instance.get_role_mining_potential_role(potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_potential_role(potential_role_id) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) patch: operationId: patchRoleMiningPotentialRole summary: Update a potential role @@ -40074,6 +46509,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-potential-role + source: | + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) /role-mining-potential-roles/saved: get: operationId: getSavedPotentialRoles @@ -40197,6 +46650,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-saved-potential-roles + source: | + 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 + + api_response = api_instance.get_saved_potential_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_potential_roles(sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(api_response) + 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 @@ -40303,6 +46774,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) /roles: get: operationId: listRoles @@ -40742,6 +47233,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) post: operationId: createRole tags: @@ -40970,6 +47483,178 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) /roles/{id}: get: operationId: getRole @@ -41038,6 +47723,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) patch: operationId: patchRole tags: @@ -41222,6 +47922,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) delete: operationId: deleteRole tags: @@ -41284,6 +48006,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) /roles/bulk-delete: post: operationId: deleteBulkRoles @@ -41401,6 +48136,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) /roles/{id}/assigned-identities: get: operationId: getRoleAssignedIdentities @@ -41526,6 +48278,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role-assigned-identities + source: | + 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: + # Identities assigned a Role + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) /roles/{id}/entitlements: get: operationId: getRoleEntitlements @@ -41641,6 +48413,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role-entitlements + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role + 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* (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 + + api_response = api_instance.get_role_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_entitlements(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) /segments: post: operationId: createSegment @@ -41822,6 +48614,44 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) get: operationId: listSegments tags: @@ -41881,6 +48711,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) /segments/{id}: get: operationId: getSegment @@ -41942,6 +48789,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) delete: operationId: deleteSegment tags: @@ -41998,6 +48860,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) patch: operationId: patchSegment tags: @@ -42100,6 +48975,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) /send-test-notification: post: operationId: sendTestNotification @@ -42180,6 +49073,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#send-test-notification + source: | + send_test_notification_request_dto = { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } # SendTestNotificationRequestDto | + try: + # Send Test Notification + Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) + api_instance.send_test_notification(Result) + + # Below is a request that includes all optional parameters + # api_instance.send_test_notification(Result) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) /service-desk-integrations: get: tags: @@ -42454,6 +49364,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integration_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) post: tags: - Service Desk Integration @@ -42549,6 +49478,51 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) /service-desk-integrations/{id}: get: tags: @@ -42616,6 +49590,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) put: tags: - Service Desk Integration @@ -42723,6 +49712,52 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) delete: tags: - Service Desk Integration @@ -42783,6 +49818,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) patch: operationId: patchServiceDeskIntegration tags: @@ -42879,6 +49927,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.beta.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) /service-desk-integrations/types: get: tags: @@ -42952,6 +50016,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) /service-desk-integrations/templates/{scriptName}: get: tags: @@ -43039,6 +50117,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) /service-desk-integrations/status-check-configuration: get: tags: @@ -43106,6 +50199,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) put: tags: - Service Desk Integration @@ -43174,6 +50281,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) /sim-integrations/{id}: put: tags: @@ -43362,6 +50487,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#put-sim-integration + source: | + id = '12345' # str | The id of the integration. # str | The id of the integration. + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.put_sim_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sim_integration(id, Result) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) get: tags: - SIM Integrations @@ -43423,6 +50581,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integration + source: | + id = '12345' # str | The id of the integration. # str | The id of the integration. + try: + # Get a SIM integration details. + + api_response = api_instance.get_sim_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integration(id) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) delete: tags: - SIM Integrations @@ -43479,6 +50652,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#delete-sim-integration + source: | + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + try: + # Delete a SIM integration + + api_instance.delete_sim_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_sim_integration(id) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) patch: tags: - SIM Integrations @@ -43560,6 +50746,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-sim-attributes + source: | + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_sim_attributes(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sim_attributes(id, Result) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) /sim-integrations/{id}/beforeProvisioningRule: patch: tags: @@ -43634,6 +50836,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-before-provisioning-rule + source: | + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_before_provisioning_rule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_before_provisioning_rule(id, Result) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) /sim-integrations: get: tags: @@ -43686,6 +50904,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integrations + source: | + try: + # List the existing SIM integrations. + + api_response = api_instance.get_sim_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integrations() + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) post: tags: - SIM Integrations @@ -43766,6 +50998,38 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#create-sim-integration + source: | + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.create_sim_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sim_integration(Result) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) /sp-config/export: post: operationId: exportSpConfig @@ -44013,6 +51277,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + export_payload = { + "description" : "Export Job 1 Test" + } # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + Result = export_payload.from_json(export_payload) + api_response = api_instance.export_sp_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_sp_config(Result) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) /sp-config/export/{id}: get: operationId: getSpConfigExportStatus @@ -44098,6 +51379,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + 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 + + api_response = api_instance.get_sp_config_export_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(api_response) + 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 @@ -44199,6 +51495,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + 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. + + api_response = api_instance.get_sp_config_export(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) /sp-config/import: post: operationId: importSpConfig @@ -44435,6 +51746,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + 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.beta.ImportOptions() # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + api_response = api_instance.import_sp_config(data, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) /sp-config/import/{id}: get: operationId: getSpConfigImportStatus @@ -44527,6 +51855,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + 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 + + api_response = api_instance.get_sp_config_import_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(api_response) + 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 @@ -44616,6 +51959,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + 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 + + api_response = api_instance.get_sp_config_import(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) /sp-config/config-objects: get: operationId: listSpConfigObjects @@ -44757,6 +52115,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + try: + # Get config object details + + api_response = api_instance.list_sp_config_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) /sources: get: operationId: listSources @@ -45205,6 +52577,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#list-sources + 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) + 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* **modified**: *eq* **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* **modified**: *eq* **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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) post: operationId: createSource security: @@ -45361,6 +52754,104 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) /sources/{id}: get: operationId: getSource @@ -45425,6 +52916,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) put: operationId: putSource security: @@ -45593,6 +53099,104 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) patch: operationId: updateSource security: @@ -45742,6 +53346,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) delete: security: - userAuth: @@ -45827,6 +53453,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete(id) + print("The response of SourcesApi->delete:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete: %s\n" % e) /sources/{id}/attribute-sync-config: get: operationId: getSourceAttrSyncConfig @@ -45951,6 +53592,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-attr-sync-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Attribute Sync Config + + api_response = api_instance.get_source_attr_sync_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_attr_sync_config(id) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) put: operationId: putSourceAttrSyncConfig tags: @@ -46043,6 +53699,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source-attr-sync-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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 + Result = attr_sync_source_config.from_json(attr_sync_source_config) + api_response = api_instance.put_source_attr_sync_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_attr_sync_config(id, Result) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) /sources/{sourceId}/connector/check-connection: post: operationId: testSourceConnection @@ -46157,6 +53846,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#test-source-connection + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + try: + # Check connection for source connector. + + api_response = api_instance.test_source_connection(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection(source_id) + print("The response of SourcesApi->test_source_connection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) /sources/{sourceId}/connector/peek-resource-objects: post: operationId: peekResourceObjects @@ -46348,6 +54052,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#peek-resource-objects + source: | + 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 + Result = resource_objects_request.from_json(resource_objects_request) + api_response = api_instance.peek_resource_objects(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.peek_resource_objects(source_id, Result) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) /sources/{sourceId}/connector/ping-cluster: post: operationId: pingCluster @@ -46412,6 +54135,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#ping-cluster + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Ping cluster for source connector + + api_response = api_instance.ping_cluster(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_cluster(source_id) + print("The response of SourcesApi->ping_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) /sources/{sourceId}/connector/test-configuration: post: operationId: testSourceConfiguration @@ -46476,6 +54214,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#test-source-configuration + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Test configuration for source connector + + api_response = api_instance.test_source_configuration(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_configuration(source_id) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) /sources/{id}/connectors/source-config: get: operationId: getSourceConfig @@ -46602,6 +54355,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-config + source: | + id = 'id_example' # str | The Source id # str | The Source id + locale = 'locale_example' # 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 + + api_response = api_instance.get_source_config(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_config(id, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) /sources/{sourceId}/native-change-detection-config: get: operationId: getNativeChangeDetectionConfig @@ -46715,6 +54484,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Native Change Detection Configuration + + api_response = api_instance.get_native_change_detection_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_native_change_detection_config(source_id) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) put: operationId: putNativeChangeDetectionConfig tags: @@ -46797,6 +54581,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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 + Result = native_change_detection_config.from_json(native_change_detection_config) + api_response = api_instance.put_native_change_detection_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_native_change_detection_config(source_id, Result) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) delete: operationId: deleteNativeChangeDetectionConfig tags: @@ -46856,6 +54663,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Delete Native Change Detection Configuration + + api_instance.delete_native_change_detection_config(source_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_native_change_detection_config(source_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) /sources/{sourceId}/provisioning-policies: get: operationId: listProvisioningPolicies @@ -46979,6 +54799,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) post: operationId: createProvisioningPolicy tags: @@ -47163,6 +54998,61 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) /sources/{sourceId}/provisioning-policies/{usageType}: get: operationId: getProvisioningPolicy @@ -47281,6 +55171,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) put: operationId: putProvisioningPolicy tags: @@ -47420,6 +55326,62 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) patch: operationId: updateProvisioningPolicy tags: @@ -47588,6 +55550,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.beta.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) delete: operationId: deleteProvisioningPolicy tags: @@ -47666,6 +55651,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -47785,6 +55784,63 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) /sources/{sourceId}/remove-accounts: post: operationId: deleteAccountsAsync @@ -47854,6 +55910,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-accounts-async + source: | + source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id + try: + # Remove All Accounts in a Source + + api_response = api_instance.delete_accounts_async(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_accounts_async(source_id) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) /sources/{sourceId}/schemas: get: operationId: getSourceSchemas @@ -48063,6 +56134,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) post: operationId: createSourceSchema security: @@ -48168,6 +56256,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.beta.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) /sources/{sourceId}/schemas/{schemaId}: get: operationId: getSourceSchema @@ -48237,6 +56341,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) put: operationId: putSourceSchema tags: @@ -48354,6 +56474,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source-schema + source: | + 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.beta.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) patch: operationId: updateSourceSchema tags: @@ -48472,6 +56609,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{op=replace, path=/displayAttribute, value={new-display-attribute=null}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) delete: operationId: deleteSourceSchema tags: @@ -48534,6 +56694,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) /sources/{sourceId}/schemas/accounts: get: tags: @@ -48594,6 +56768,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-accounts-schema + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_source_accounts_schema(source_id) + + # Below is a request that includes all optional parameters + # api_instance.get_source_accounts_schema(source_id) + except Exception as e: + print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) post: tags: - Sources @@ -48663,6 +56850,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-accounts-schema + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_source_accounts_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_accounts_schema(source_id, file) + print("The response of SourcesApi->import_source_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) /sources/{sourceId}/schemas/entitlements: get: tags: @@ -48730,6 +56933,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlements-schema + source: | + source_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 + + api_instance.get_source_entitlements_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_source_entitlements_schema(source_id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) post: tags: - Sources @@ -48806,6 +57023,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-entitlements-schema + source: | + source_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 + + api_response = api_instance.import_source_entitlements_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_entitlements_schema(source_id, schema_name, file) + print("The response of SourcesApi->import_source_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) /sources/{sourceId}/upload-connector-file: post: operationId: importSourceConnectorFile @@ -48878,6 +57112,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-connector-file + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_source_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_connector_file(source_id, file) + print("The response of SourcesApi->import_source_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) /sources/{sourceId}/synchronize-attributes: post: operationId: syncAttributesForSource @@ -48975,6 +57225,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#sync-attributes-for-source + source: | + source_id = 'source_id_example' # str | The Source id # str | The Source id + try: + # Synchronize single source attributes. + + api_response = api_instance.sync_attributes_for_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_attributes_for_source(source_id) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) /sources/{sourceId}/entitlement-request-config: get: security: @@ -49076,6 +57341,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlement-request-config + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Get Source Entitlement Request Configuration + + api_response = api_instance.get_source_entitlement_request_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_entitlement_request_config(source_id) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) put: security: - userAuth: @@ -49189,6 +57469,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source-entitlement-request-config + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + 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 + Result = source_entitlement_request_config.from_json(source_entitlement_request_config) + api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) /sources/{sourceId}/load-accounts: post: tags: @@ -49467,6 +57775,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-accounts + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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 + + api_response = api_instance.import_accounts(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts(source_id, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) /sources/{sourceId}/load-entitlements: post: tags: @@ -49541,6 +57866,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-entitlements + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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: + # Entitlement Aggregation + + api_response = api_instance.import_entitlements(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements(source_id, file) + print("The response of SourcesApi->import_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) /sources/{sourceId}/load-uncorrelated-accounts: post: tags: @@ -49780,6 +58121,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-uncorrelated-accounts + source: | + source_id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Process Uncorrelated Accounts + + api_response = api_instance.import_uncorrelated_accounts(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_uncorrelated_accounts(source_id, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) /sources/{sourceId}/correlation-config: get: operationId: getCorrelationConfig @@ -49899,6 +58256,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-correlation-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + api_response = api_instance.get_correlation_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_correlation_config(source_id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) put: operationId: putCorrelationConfig tags: @@ -49995,6 +58367,42 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-correlation-config + source: | + source_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 + Result = correlation_config.from_json(correlation_config) + api_response = api_instance.put_correlation_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_correlation_config(source_id, Result) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) /source-apps/{id}: get: operationId: getSourceApp @@ -50147,6 +58555,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#get-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + try: + # Get source app by ID + + api_response = api_instance.get_source_app(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_app(id) + print("The response of AppsApi->get_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) patch: operationId: patchSourceApp tags: @@ -50376,6 +58799,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#patch-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch source app by ID + + api_response = api_instance.patch_source_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_source_app(id, Result) + print("The response of AppsApi->patch_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) delete: operationId: deleteSourceApp security: @@ -50435,6 +58880,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#delete-source-app + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. + try: + # Delete source app by ID + + api_response = api_instance.delete_source_app(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source_app(id) + print("The response of AppsApi->delete_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) /source-apps/bulk-update: post: operationId: updateSourceAppsInBulk @@ -50532,6 +58992,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#update-source-apps-in-bulk + source: | + 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 + + api_instance.update_source_apps_in_bulk() + + # Below is a request that includes all optional parameters + # api_instance.update_source_apps_in_bulk(Result) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) /source-apps/assigned: get: operationId: listAssignedSourceApp @@ -50630,6 +59114,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-assigned-source-app + 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) + 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 + + api_response = api_instance.list_assigned_source_app() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_assigned_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) /source-apps: get: operationId: listAvailableSourceApps @@ -50728,6 +59231,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-available-source-apps + 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) + 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 + + api_response = api_instance.list_available_source_apps() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_source_apps(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) post: operationId: createSourceApp tags: @@ -50838,6 +59360,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#create-source-app + source: | + 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 + Result = source_app_create_dto.from_json(source_app_create_dto) + api_response = api_instance.create_source_app(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_app(Result) + print("The response of AppsApi->create_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) /source-apps/all: get: operationId: listAllSourceApp @@ -50943,6 +59489,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-all-source-app + 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) + 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 + + api_response = api_instance.list_all_source_app() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) /source-apps/{id}/access-profiles: get: operationId: listAccessProfilesForSourceApp @@ -51224,6 +59789,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-access-profiles-for-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + 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 + + api_response = api_instance.list_access_profiles_for_source_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles_for_source_app(id, limit, offset, filters) + print("The response of AppsApi->list_access_profiles_for_source_app:\n") + pprint(api_response) + 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 @@ -51304,6 +59887,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # 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 + Result = request_body.from_json(request_body) + api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) /task-status/{id}: get: tags: @@ -51379,6 +59981,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status + source: | + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + try: + # Get Task Status by ID + + api_response = api_instance.get_task_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status(id) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) patch: operationId: updateTaskStatus tags: @@ -51474,6 +60091,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#update-task-status + source: | + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + try: + # Update Task Status by ID + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_task_status(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_task_status(id, Result) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) /task-status: get: tags: @@ -51583,6 +60222,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status-list + 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) + 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 + + api_response = api_instance.get_task_status_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status_list(limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) /task-status/pending-tasks: get: tags: @@ -51660,6 +60318,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-tasks + source: | + 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 + + api_response = api_instance.get_pending_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_tasks(offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) head: tags: - Task Management @@ -51729,6 +60404,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-task-headers + source: | + 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 + + api_instance.get_pending_task_headers() + + # Below is a request that includes all optional parameters + # api_instance.get_pending_task_headers(offset, limit, count) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) /tagged-objects: get: operationId: listTaggedObjects @@ -51844,6 +60534,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) post: operationId: setTagToObject security: @@ -51908,6 +60616,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) /tagged-objects/{type}: get: operationId: listTaggedObjectsByType @@ -52005,6 +60733,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) /tagged-objects/{type}/{id}: get: operationId: getTaggedObject @@ -52082,6 +60829,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) put: operationId: putTaggedObject security: @@ -52175,6 +60938,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) delete: operationId: deleteTaggedObject security: @@ -52245,6 +61032,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -52367,6 +61168,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tags-to-many-objects + source: | + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + Result = bulk_tagged_object.from_json(bulk_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) /tagged-objects/bulk-remove: post: operationId: deleteTagsToManyObject @@ -52439,6 +61267,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tags-to-many-object + source: | + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Remove Tags from Multiple Objects + Result = bulk_tagged_object.from_json(bulk_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) /tags: get: operationId: listTags @@ -52582,6 +61435,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#list-tags + 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) + filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # 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,-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** (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** (optional) + try: + # List Tags + + api_response = api_instance.list_tags() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tags(limit, offset, count, filters, sorters) + print("The response of TagsApi->list_tags:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->list_tags: %s\n" % e) post: operationId: createTag tags: @@ -52678,6 +61550,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#create-tag + source: | + tag = { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "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" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } # Tag | + try: + # Create Tag + Result = tag.from_json(tag) + api_response = api_instance.create_tag(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_tag(Result) + print("The response of TagsApi->create_tag:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->create_tag: %s\n" % e) /tags/{id}: get: operationId: getTagById @@ -52740,6 +61641,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#get-tag-by-id + source: | + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get Tag By Id + + api_response = api_instance.get_tag_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tag_by_id(id) + print("The response of TagsApi->get_tag_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) delete: operationId: deleteTagById tags: @@ -52819,6 +61735,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#delete-tag-by-id + source: | + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete. + try: + # Delete Tag + + api_instance.delete_tag_by_id(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tag_by_id(id) + except Exception as e: + print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) /tenant: get: operationId: getTenant @@ -52994,6 +61923,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tenant#get-tenant + source: | + try: + # Get Tenant Information. + + api_response = api_instance.get_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) /transforms: get: tags: @@ -53117,6 +62060,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) post: tags: - Transforms @@ -54033,6 +62995,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) /transforms/{id}: get: tags: @@ -54100,6 +63081,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) put: tags: - Transforms @@ -54209,6 +63205,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) delete: tags: - Transforms @@ -54270,6 +63286,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) /translation-catalogs/{catalog-id}: get: operationId: getMessageCatalogs @@ -54342,6 +63371,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-message-catalogs#get-message-catalogs + source: | + catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog. + try: + # Get Message catalogs + + api_response = api_instance.get_message_catalogs(catalog_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_message_catalogs(catalog_id) + print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) /triggers: get: operationId: listTriggers @@ -56454,6 +65498,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-triggers + 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) + 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 + + api_response = api_instance.list_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_triggers(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) /trigger-subscriptions: post: operationId: createSubscription @@ -56757,6 +65820,45 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#create-subscription + source: | + 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 + Result = subscription_post_request.from_json(subscription_post_request) + api_response = api_instance.create_subscription(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_subscription(Result) + print("The response of TriggersApi->create_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) get: operationId: listSubscriptions tags: @@ -56894,6 +65996,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-subscriptions + 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) + 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 + + api_response = api_instance.list_subscriptions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_subscriptions(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) /trigger-subscriptions/{id}: put: operationId: updateSubscription @@ -57077,6 +66198,45 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#update-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + 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 + Result = subscription_put_request.from_json(subscription_put_request) + api_response = api_instance.update_subscription(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_subscription(id, Result) + print("The response of TriggersApi->update_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) patch: operationId: patchSubscription tags: @@ -57192,6 +66352,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#patch-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch + [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + try: + # Patch a Subscription + Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) + api_response = api_instance.patch_subscription(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_subscription(id, Result) + print("The response of TriggersApi->patch_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) delete: operationId: deleteSubscription tags: @@ -57249,6 +66427,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#delete-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + try: + # Delete a Subscription + + api_instance.delete_subscription(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_subscription(id) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) /trigger-subscriptions/validate-filter: post: operationId: testSubscriptionFilter @@ -57354,6 +66545,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#test-subscription-filter + source: | + validate_filter_input_dto = { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } # ValidateFilterInputDto | + try: + # Validate a Subscription Filter + Result = validate_filter_input_dto.from_json(validate_filter_input_dto) + api_response = api_instance.test_subscription_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_subscription_filter(Result) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) /trigger-invocations/status: get: operationId: listTriggerInvocationStatus @@ -57521,6 +66732,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-trigger-invocation-status + 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) + 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 + + api_response = api_instance.list_trigger_invocation_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_trigger_invocation_status(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) /trigger-invocations/{id}/complete: post: operationId: completeTriggerInvocation @@ -57610,6 +66840,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#complete-trigger-invocation + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. + complete_invocation = { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } # CompleteInvocation | + try: + # Complete Trigger Invocation + Result = complete_invocation.from_json(complete_invocation) + api_instance.complete_trigger_invocation(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.complete_trigger_invocation(id, Result) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) /trigger-invocations/test: post: operationId: startTestTriggerInvocation @@ -57740,6 +66990,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#start-test-trigger-invocation + source: | + 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 + Result = test_invocation.from_json(test_invocation) + api_response = api_instance.start_test_trigger_invocation(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_test_trigger_invocation(Result) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) /ui-metadata/tenant: get: operationId: getTenantUiMetadata @@ -57809,6 +67083,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/ui-metadata#get-tenant-ui-metadata + source: | + try: + # Get a tenant UI metadata + + api_response = api_instance.get_tenant_ui_metadata() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_ui_metadata() + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) put: operationId: setTenantUiMetadata tags: @@ -57892,6 +67180,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/ui-metadata#set-tenant-ui-metadata + source: | + 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 + Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + api_response = api_instance.set_tenant_ui_metadata(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tenant_ui_metadata(Result) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) /user-apps/{id}: patch: operationId: patchUserApp @@ -58074,6 +67381,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#patch-user-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch user app by ID + + api_response = api_instance.patch_user_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_user_app(id, Result) + print("The response of AppsApi->patch_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) /user-apps/{id}/available-accounts: get: operationId: listAvailableAccountsForUserApp @@ -58175,6 +67504,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-available-accounts-for-user-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app + 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 available accounts for user app + + api_response = api_instance.list_available_accounts_for_user_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_accounts_for_user_app(id, limit, count, offset) + print("The response of AppsApi->list_available_accounts_for_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) /user-apps: get: operationId: listOwnedUserApps @@ -58259,6 +67606,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-owned-user-apps + 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) + 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 + + api_response = api_instance.list_owned_user_apps() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_owned_user_apps(limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) /user-apps/all: get: operationId: listAllUserApps @@ -58347,6 +67712,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-all-user-apps + source: | + 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* + 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 + + api_response = api_instance.list_all_user_apps(filters, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_user_apps(filters, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) /verified-from-addresses: get: operationId: listFromAddresses @@ -58440,6 +67823,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-from-addresses + 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) + 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 + + api_response = api_instance.list_from_addresses() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) post: operationId: createVerifiedFromAddress tags: @@ -58503,6 +67905,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-verified-from-address + source: | + email_status_dto = { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } # EmailStatusDto | + try: + # Create Verified From Address + Result = email_status_dto.from_json(email_status_dto) + api_response = api_instance.create_verified_from_address(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_verified_from_address(Result) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) /verified-from-addresses/{id}: delete: operationId: deleteVerifiedFromAddress @@ -58556,6 +67978,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#delete-verified-from-address + source: | + id = 'id_example' # str | # str | + try: + # Delete Verified From Address + + api_instance.delete_verified_from_address(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_verified_from_address(id) + except Exception as e: + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) /verified-domains: get: security: @@ -58634,6 +68069,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-dkim-attributes + source: | + try: + # Get DKIM Attributes + + api_response = api_instance.get_dkim_attributes() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dkim_attributes() + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) post: security: - userAuth: @@ -58742,6 +68191,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-domain-dkim + source: | + domain_address = { + "domain" : "sailpoint.com" + } # DomainAddress | + try: + # Verify domain address via DKIM + Result = domain_address.from_json(domain_address) + api_response = api_instance.create_domain_dkim(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_domain_dkim(Result) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) /sod-policies: post: operationId: createSodPolicy @@ -59167,6 +68633,76 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) get: operationId: listSodPolicies tags: @@ -59322,6 +68858,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) /sod-policies/{id}: get: operationId: getSodPolicy @@ -59454,6 +69009,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD policy by ID + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) put: operationId: putSodPolicy tags: @@ -59717,6 +69287,77 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#put-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) delete: operationId: deleteSodPolicy tags: @@ -59785,6 +69426,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) + try: + # Delete SOD policy by ID + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) patch: operationId: patchSodPolicy tags: @@ -59963,6 +69618,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#patch-sod-policy + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + request_body = [{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[object] | 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 + request_body = [{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[object] | 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 a SOD policy + Result = request_body.from_json(request_body) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) /sod-policies/{id}/schedule: get: operationId: getSodPolicySchedule @@ -60181,6 +69854,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD policy schedule + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) put: operationId: putPolicySchedule tags: @@ -60338,6 +70026,107 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#put-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } # SodPolicySchedule | + try: + # Update SOD Policy schedule + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) delete: operationId: deleteSodPolicySchedule tags: @@ -60397,6 +70186,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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: operationId: startSodPolicy @@ -60496,6 +70298,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) /sod-policies/{id}/violation-report: get: operationId: getSodViolationReportStatus @@ -60566,6 +70383,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-status + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD violation report status + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) /sod-violations/predict: post: operationId: startPredictSodViolations @@ -60779,6 +70611,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) /sod-policies/sod-violation-report-status/{reportResultId}: get: operationId: getSodViolationReportRunStatus @@ -60849,6 +70707,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) /sod-violation-report/run: post: operationId: startSodAllPoliciesForOrg @@ -60927,6 +70800,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-all-policies-for-org + source: | + multi_policy_request = { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) /sod-violation-report: get: operationId: getSodAllReportRunStatus @@ -60984,6 +70874,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) /sod-violation-report/{reportResultId}/download: get: operationId: getDefaultViolationReport @@ -61049,6 +70953,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) /sod-violation-report/{reportResultId}/download/{fileName}: get: operationId: getCustomViolationReport @@ -61122,6 +71041,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) /work-items: get: operationId: listWorkItems @@ -61259,6 +71194,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#list-work-items + 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) + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) /work-items/completed: get: operationId: getCompletedWorkItems @@ -61318,6 +71271,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-completed-work-items + source: | + owner_id = 'owner_id_example' # 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) /work-items/count: get: operationId: getCountWorkItems @@ -61370,6 +71341,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-count-work-items + source: | + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) /work-items/completed/count: get: operationId: getCountCompletedWorkItems @@ -61420,6 +71406,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-count-completed-work-items + source: | + 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 + + api_response = api_instance.get_count_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) /work-items/summary: get: operationId: getWorkItemsSummary @@ -61480,6 +71481,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-work-items-summary + source: | + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) /work-items/{id}: get: operationId: getWorkItem @@ -61538,6 +71554,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-work-item + source: | + id = 'id_example' # str | ID of the work item. # str | ID of the work item. + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id, owner_id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) post: operationId: completeWorkItem tags: @@ -61587,6 +71619,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) /work-items/{id}/forward: post: operationId: forwardWorkItem @@ -61669,6 +71716,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + try: + # Forward a Work Item + Result = work_item_forward.from_json(work_item_forward) + api_instance.forward_work_item(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.forward_work_item(id, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) /work-items/{id}/approve/{approvalItemId}: post: operationId: approveApprovalItem @@ -61727,6 +71792,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) /work-items/{id}/reject/{approvalItemId}: post: operationId: rejectApprovalItem @@ -61785,6 +71866,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) /work-items/bulk-approve/{id}: post: operationId: approveApprovalItemsInBulk @@ -61835,6 +71932,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + 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 @@ -61885,6 +71997,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + 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 @@ -61947,6 +72074,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) /workflows: post: operationId: createWorkflow @@ -62285,6 +72428,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) get: operationId: listWorkflows tags: @@ -62335,6 +72493,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) /workflows/{id}: get: operationId: getWorkflow @@ -62396,6 +72568,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) put: operationId: updateWorkflow tags: @@ -62504,6 +72691,59 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow + source: | + 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" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.update_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workflow(id, Result) + print("The response of WorkflowsApi->update_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) patch: operationId: patchWorkflow tags: @@ -62622,6 +72862,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) delete: operationId: deleteWorkflow tags: @@ -62678,6 +72940,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) /workflows/{id}/test: post: operationId: testWorkflow @@ -62787,6 +73062,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) /workflows/{id}/executions: get: operationId: getWorkflowExecutions @@ -62919,6 +73210,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + 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: **startTime**: *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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) /workflow-executions/{id}: get: operationId: getWorkflowExecution @@ -62984,6 +73294,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) /workflow-executions/{id}/history: get: operationId: getWorkflowExecutionHistory @@ -63075,6 +73400,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) /workflow-executions/{id}/cancel: post: operationId: cancelWorkflowExecution @@ -63135,6 +73475,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) /workflow-library: get: operationId: listCompleteWorkflowLibrary @@ -63521,6 +73874,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) /workflow-library/actions: get: operationId: listWorkflowLibraryActions @@ -63595,6 +73964,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) /workflow-library/triggers: get: operationId: listWorkflowLibraryTriggers @@ -63669,6 +74055,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) /workflow-library/operators: get: operationId: listWorkflowLibraryOperators @@ -63720,6 +74123,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) /workflows/{id}/external/oauth-clients: post: operationId: postWorkflowExternalTrigger @@ -63793,6 +74210,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.post_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) /workflows/execute/external/{id}: post: operationId: postExternalExecuteWorkflow @@ -63878,6 +74310,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.post_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.post_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) /workflows/execute/external/{id}/test: post: operationId: testExternalExecuteWorkflow @@ -63959,6 +74407,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.beta.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) /workgroups: get: operationId: listWorkgroups @@ -64099,6 +74563,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroups + source: | + 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 + + api_response = api_instance.list_workgroups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) post: operationId: createWorkgroup security: @@ -64173,6 +74656,36 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#create-workgroup + source: | + 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. + Result = workgroup_dto.from_json(workgroup_dto) + api_response = api_instance.create_workgroup(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workgroup(Result) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) /workgroups/{id}: get: operationId: getWorkgroup @@ -64231,6 +74744,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#get-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + try: + # Get Governance Group by Id + + api_response = api_instance.get_workgroup(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workgroup(id) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) delete: operationId: deleteWorkgroup tags: @@ -64284,6 +74812,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + try: + # Delete a Governance Group + + api_instance.delete_workgroup(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workgroup(id) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) patch: operationId: patchWorkgroup tags: @@ -64369,6 +74910,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#patch-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch a Governance Group + + api_response = api_instance.patch_workgroup(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workgroup(id, Result) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) /workgroups/bulk-delete: post: operationId: deleteWorkgroupsInBulk @@ -64493,6 +75056,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroups-in-bulk + source: | + workgroup_bulk_delete_request = { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } # WorkgroupBulkDeleteRequest | + try: + # Delete Governance Group(s) + Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + api_response = api_instance.delete_workgroups_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroups_in_bulk(Result) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) /workgroups/{workgroupId}/connections: get: operationId: listConnections @@ -64606,6 +75186,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-connections + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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 + + api_response = api_instance.list_connections(workgroup_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_connections(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) /workgroups/{workgroupId}/members: get: operationId: listWorkgroupMembers @@ -64706,6 +75305,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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 + + api_response = api_instance.list_workgroup_members(workgroup_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroup_members(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) /workgroups/{workgroupId}/members/bulk-add: post: operationId: updateWorkgroupMembers @@ -64837,6 +75455,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#update-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + + try: + # Add members to Governance Group + Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + api_response = api_instance.update_workgroup_members(workgroup_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workgroup_members(workgroup_id, Result) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) /workgroups/{workgroupId}/members/bulk-delete: post: operationId: deleteWorkgroupMembers @@ -64944,6 +75580,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + + try: + # Remove members from Governance Group + Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) /form-definitions: get: tags: @@ -65169,6 +75823,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-definitions-by-tenant + source: | + 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. + + api_response = api_instance.search_form_definitions_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) post: tags: - Custom Forms @@ -65478,6 +76150,7 @@ paths: STRING FormDefinitionInputTypeString enum: - STRING + - ARRAY example: STRING type: string x-go-enum-desc: STRING FormDefinitionInputTypeString @@ -65873,6 +76546,131 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition + source: | + create_form_definition_request = { + "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. + + api_response = api_instance.create_form_definition() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition(Result) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) /form-definitions/{formDefinitionID}: get: tags: @@ -66041,6 +76839,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-definition-by-key + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Return a form definition. + + api_response = api_instance.get_form_definition_by_key(form_definition_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_definition_by_key(form_definition_id) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) delete: tags: - Custom Forms @@ -66209,6 +77022,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#delete-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Deletes a form definition. + + api_response = api_instance.delete_form_definition(form_definition_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_form_definition(form_definition_id) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) patch: tags: - Custom Forms @@ -66405,6 +77233,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-definition + source: | + 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) + 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. + + api_response = api_instance.patch_form_definition(form_definition_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_definition(form_definition_id, Result) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) /form-definitions/{formDefinitionID}/data-source: post: tags: @@ -66752,6 +77598,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#show-preview-data-source + source: | + 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. + + api_response = api_instance.show_preview_data_source(form_definition_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_preview_data_source(form_definition_id, limit, filters, query, Result) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) /form-definitions/export: get: tags: @@ -66981,6 +77856,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#export-form-definitions-by-tenant + source: | + 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. + + api_response = api_instance.export_form_definitions_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(api_response) + 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: @@ -67219,6 +78112,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-dynamic-schema + source: | + 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. + + api_response = api_instance.create_form_definition_dynamic_schema() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_dynamic_schema(Result) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) /form-definitions/import: post: tags: @@ -67497,6 +78413,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#import-form-definitions + source: | + [{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) + 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. + + api_response = api_instance.import_form_definitions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_form_definitions(Result) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) /form-definitions/template: post: tags: @@ -67761,6 +78694,131 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-by-template + source: | + create_form_definition_request = { + "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: + # Create a form definition by template. + + api_response = api_instance.create_form_definition_by_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_by_template(Result) + print("The response of CustomFormsApi->create_form_definition_by_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) /form-definitions/{formDefinitionID}/upload: post: tags: @@ -68036,6 +79094,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-file-request + source: | + 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. + + api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) /form-definitions/{formDefinitionID}/file/{fileID}: get: tags: @@ -68616,6 +79690,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-file-from-s3 + source: | + 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. + + api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) /form-instances: get: tags: @@ -68913,6 +80003,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-instances-by-tenant + source: | + try: + # List form instances by tenant. + + api_response = api_instance.search_form_instances_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_instances_by_tenant() + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) post: tags: - Custom Forms @@ -69155,6 +80259,41 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-instance + source: | + 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. + + api_response = api_instance.create_form_instance() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_instance(Result) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) /form-instances/{formInstanceID}: get: tags: @@ -69322,6 +80461,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-by-key + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID + try: + # Returns a form instance. + + api_response = api_instance.get_form_instance_by_key(form_instance_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_by_key(form_instance_id) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) patch: tags: - Custom Forms @@ -69533,6 +80687,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-instance + source: | + 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) + 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. + + api_response = api_instance.patch_form_instance(form_instance_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_instance(form_instance_id, Result) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) /form-instances/{formInstanceID}/data-source/{formElementID}: get: tags: @@ -69769,6 +80941,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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. + + api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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: @@ -70349,6 +81540,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-file + source: | + 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. + + api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) /form-definitions/predefined-select-options: get: tags: @@ -70492,6 +81699,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-pre-defined-select-options + source: | + try: + # List predefined select options. + + api_response = api_instance.search_pre_defined_select_options() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_pre_defined_select_options() + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) /source-usages/{sourceId}/status: get: tags: @@ -70563,6 +81784,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) /source-usages/{sourceId}/summaries: get: tags: @@ -70654,6 +81890,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) /account-usages/{accountId}/summaries: get: tags: @@ -70745,6 +82000,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}: get: tags: @@ -70867,6 +82141,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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 + + api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) /manual-discover-applications-template: get: summary: Download CSV Template for Discovery @@ -70930,6 +82221,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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 @@ -70993,6 +82298,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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) /discovered-applications: get: operationId: getDiscoveredApplications @@ -71294,6 +82612,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-applications + 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) + 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: + # Retrieve discovered applications for tenant + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) /discovered-applications/{id}: get: operationId: getDiscoveredApplicationByID @@ -71366,6 +82703,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-application-by-id + source: | + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + try: + # Get Discovered Application by ID + + api_instance.get_discovered_application_by_id(id) + + # Below is a request that includes all optional parameters + # api_instance.get_discovered_application_by_id(id) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) patch: operationId: patchDiscoveredApplicationByID tags: @@ -71513,6 +82863,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#patch-discovered-application-by-id + source: | + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + [{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional) + json_patch_operations = { + "op" : "replace", + "path" : "/dismissed", + "value" : true + } # List[JsonPatchOperations] | (optional) + + try: + # Patch Discovered Application by ID + + api_instance.patch_discovered_application_by_id(id, ) + + # Below is a request that includes all optional parameters + # api_instance.patch_discovered_application_by_id(id, Result) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) /vendor-connector-mappings: get: security: @@ -71682,6 +83052,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) post: security: - userAuth: @@ -71767,6 +83151,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) delete: security: - userAuth: @@ -71856,6 +83277,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) /icons/{objectType}/{objectId}: put: operationId: setIcon @@ -71947,6 +83405,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/icons#set-icon + source: | + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + 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 + + api_response = api_instance.set_icon(object_type, object_id, image) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_icon(object_type, object_id, image) + print("The response of IconsApi->set_icon:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) delete: operationId: deleteIcon tags: @@ -72014,6 +83489,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/icons#delete-icon + source: | + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + try: + # Delete an icon + + api_instance.delete_icon(object_type, object_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_icon(object_type, object_id) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) /suggested-entitlement-description-batches/{batchId}/stats: get: tags: @@ -72107,6 +83596,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + api_response = api_instance.get_sed_batch_stats(batch_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) /suggested-entitlement-description-batches: get: tags: @@ -72166,6 +83670,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batches + source: | + try: + # List Sed Batch Request + + api_response = api_instance.get_sed_batches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) post: tags: - Suggested Entitlement Description @@ -72257,6 +83775,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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 + + api_response = api_instance.submit_sed_batch_request() + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_batch_request(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) /suggested-entitlement-description-approvals: post: tags: @@ -72350,6 +83886,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-approval + source: | + [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + try: + # Submit Bulk Approval Request + Result = sed_approval.from_json(sed_approval) + api_response = api_instance.submit_sed_approval(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_approval(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) /suggested-entitlement-description-assignments: post: tags: @@ -72463,6 +84018,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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 + Result = sed_assignment.from_json(sed_assignment) + api_response = api_instance.submit_sed_assignment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_assignment(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) /suggested-entitlement-descriptions: get: tags: @@ -72673,6 +84249,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#list-seds + source: | + limit = limit=25 # int | 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) # int | 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) + 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 = count=true # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + count_only = count-only=true # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + requested_by_anyone = requested-by-anyone=true # 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) # 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) + show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) + try: + # List Suggested Entitlement Descriptions + + api_response = api_instance.list_seds() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) patch: tags: - Suggested Entitlement Description @@ -72768,6 +84365,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#patch-sed + source: | + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + [sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + try: + # Patch Suggested Entitlement Description + Result = sed_patch.from_json(sed_patch) + api_response = api_instance.patch_sed(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sed(id, Result) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) /launchers: get: tags: @@ -72946,6 +84565,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#get-launchers + source: | + filters = 'disabled 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: **description**: *sw* **disabled**: *eq* **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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional) + limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10) + try: + # List all Launchers for tenant + + api_response = api_instance.get_launchers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_launchers(filters, next, limit) + print("The response of LaunchersApi->get_launchers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) post: tags: - Launchers @@ -73067,6 +84703,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#create-launcher + source: | + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to create a Launcher + try: + # Create launcher + Result = launcher_request.from_json(launcher_request) + api_response = api_instance.create_launcher(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_launcher(Result) + print("The response of LaunchersApi->create_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) /launchers/{launcherID}: get: tags: @@ -73133,6 +84794,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#get-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved + try: + # Get Launcher by ID + + api_response = api_instance.get_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_launcher(launcher_id) + print("The response of LaunchersApi->get_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) put: tags: - Launchers @@ -73219,6 +84895,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#put-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to replace Launcher + try: + # Replace Launcher + Result = launcher_request.from_json(launcher_request) + api_response = api_instance.put_launcher(launcher_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_launcher(launcher_id, Result) + print("The response of LaunchersApi->put_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) delete: tags: - Launchers @@ -73278,6 +84980,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#delete-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted + try: + # Delete Launcher + + api_instance.delete_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_launcher(launcher_id) + except Exception as e: + print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) /beta/launchers/{launcherID}/launch: post: tags: @@ -73349,3 +85064,18 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#start-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched + try: + # Launch a Launcher + + api_response = api_instance.start_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_launcher(launcher_id) + print("The response of LaunchersApi->start_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) diff --git a/static/code-examples/beta/merged_code_examples.yaml b/static/code-examples/beta/merged_code_examples.yaml new file mode 100644 index 000000000..aff981f05 --- /dev/null +++ b/static/code-examples/beta/merged_code_examples.yaml @@ -0,0 +1,26293 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # Get Access Model Metadata Attribute + + try { + Get-BetaAccessModelMetadataAttribute -Key $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -Key $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + try: + # Get Access Model Metadata Attribute + + api_response = api_instance.get_access_model_metadata_attribute(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute(key) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Get Access Model Metadata Value + + try { + Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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. + try: + # Get Access Model Metadata Value + + api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + $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) + + # List Access Model Metadata Attributes + + try { + Get-BetaAccessModelMetadataAttribute + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + 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 + + api_response = api_instance.list_access_model_metadata_attribute() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute(filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # List Access Model Metadata Values + + try { + Get-BetaAccessModelMetadataAttributeValue -Key $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -Key $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + try: + # List Access Model Metadata Values + + api_response = api_instance.list_access_model_metadata_attribute_value(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute_value(key) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "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 + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-BetaAccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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* 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) + + # List Access Profiles + + try { + Get-BetaAccessProfiles + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfiles -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-BetaAccessProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* 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* 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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-BetaAccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-BetaAccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $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 = "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* 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, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-BetaAccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-profiles#update-access-profiles-in-bulk + source: | + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#update-access-profiles-in-bulk + source: | + [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + + try: + # Update Access Profile(s) requestable field. + Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + api_response = api_instance.update_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#approve-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + try: + # Approve Access Request Approval + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.approve_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#forward-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + forward_approval_dto = { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-BetaAccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "MyOwnerId" # String | 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 # 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 = "MyFilters" # 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, 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 = "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: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-BetaCompletedApprovals + + # Below is a request that includes all optional parameters + # Get-BetaCompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-completed-approvals + source: | + owner_id = 'owner_id_example' # 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 = '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: **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 = '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: **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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "MyOwnerId" # String | 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 # 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 = "MyFilters" # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-BetaPendingApprovals + + # Below is a request that includes all optional parameters + # Get-BetaPendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-pending-approvals + source: | + owner_id = 'owner_id_example' # 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 = '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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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* (optional) + 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: **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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#reject-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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 + + api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-BetaAccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-BetaAccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#close-access-request + source: | + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-BetaAccessRequest -CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-BetaAccessRequest -CloseAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#close-access-request + source: | + close_access_request = { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } # CloseAccessRequest | + try: + # Close Access Request + Result = close_access_request.from_json(close_access_request) + api_response = api_instance.close_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.close_access_request(Result) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "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" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-BetaAccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-BetaAccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "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 + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-BetaAccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaAccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | 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) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | 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 # Boolean | 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 = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | 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"" # 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: **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" # 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, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-BetaAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get Account Activity + + try { + Get-BetaAccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-activities#list-account-activities + source: | + $RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "MyRegardingIdentity" # String | 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) + $Type = "MyType" # String | The type of account activity. (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 = "MyFilters" # 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: **type**: *eq, in, ge, gt, 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 = "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: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-BetaAccountActivities + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-activities#list-account-activities + source: | + requested_for = 'requested_for_example' # 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 = 'requested_by_example' # 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 = 'regarding_identity_example' # 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) + type = 'type_example' # str | The type of account activity. (optional) # str | The type of account activity. (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 = '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: **type**: *eq, in, ge, gt, 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, gt, 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 = '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: **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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-aggregations#get-account-aggregation-status + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + + # In-progress Account Aggregation status + + try { + Get-BetaAccountAggregationStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountAggregationStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-aggregations#get-account-aggregation-status + source: | + id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id + try: + # In-progress Account Aggregation status + + api_response = api_instance.get_account_aggregation_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_aggregation_status(id) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 = "-date" # 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: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-BetaAccount -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaAccount -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#list-accounts + source: | + $DetailLevel = "SLIM" # String | 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) + $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* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + + # Accounts List + + try { + Get-BetaAccounts + + # Below is a request that includes all optional parameters + # Get-BetaAccounts -DetailLevel $DetailLevel -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#list-accounts + source: | + 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) + 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* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.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, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + try: + # Accounts List + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(detail_level, limit, offset, count, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-BetaAccount -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-BetaAccount -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-BetaAccount -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-BetaAccount -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaAccount -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccount -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#update-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Account + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account-async + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + + # Remove Account + + try { + Remove-BetaAccountAsync -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountAsync -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#delete-account-async + source: | + id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id + try: + # Remove Account + + api_response = api_instance.delete_account_async(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account_async(id) + print("The response of AccountsApi->delete_account_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-BetaAccount -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccount -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Disable IDN Account for Identity + + try { + Disable-BetaAccountForIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Disable-BetaAccountForIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-account-for-identity + source: | + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + try: + # Disable IDN Account for Identity + + api_response = api_instance.disable_account_for_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account_for_identity(id) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-accounts-for-identities + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-accounts-for-identities + source: | + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + try: + # Disable IDN Accounts for Identities + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.disable_accounts_for_identities(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_accounts_for_identities(Result) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-BetaAccount -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccount -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account-for-identity + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Enable IDN Account for Identity + + try { + Enable-BetaAccountForIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Enable-BetaAccountForIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-account-for-identity + source: | + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + try: + # Enable IDN Account for Identity + + api_response = api_instance.enable_account_for_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account_for_identity(id) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-accounts-for-identities + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-accounts-for-identities + source: | + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + try: + # Enable IDN Accounts for Identities + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.enable_accounts_for_identities(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_accounts_for_identities(Result) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $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) + + # Account Entitlements + + try { + Get-BetaAccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountEntitlements -Id $Id -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#get-account-entitlements + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + 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: + # Account Entitlements + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, offset, limit, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-BetaReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +- path: /discovered-applications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-application-by-id + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + + # Get Discovered Application by ID + + try { + Get-BetaDiscoveredApplicationByID -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplicationByID -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-application-by-id + source: | + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + try: + # Get Discovered Application by ID + + api_instance.get_discovered_application_by_id(id) + + # Below is a request that includes all optional parameters + # api_instance.get_discovered_application_by_id(id) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) +- path: /discovered-applications/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#patch-discovered-application-by-id + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + $JsonPatchOperations = @"{ + "op" : "replace", + "path" : "/dismissed", + "value" : true + }"@ + + + # Patch Discovered Application by ID + + try { + Update-BetaDiscoveredApplicationByID -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaDiscoveredApplicationByID -Id $Id -JsonPatchOperations $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#patch-discovered-application-by-id + source: | + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + [{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional) + json_patch_operations = { + "op" : "replace", + "path" : "/dismissed", + "value" : true + } # List[JsonPatchOperations] | (optional) + + try: + # Patch Discovered Application by ID + + api_instance.patch_discovered_application_by_id(id, ) + + # Below is a request that includes all optional parameters + # api_instance.patch_discovered_application_by_id(id, Result) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $Detail = "SLIM" # String | 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")" # 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, 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" # 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, description, discoveredAt, discoverySource** (optional) + + # Retrieve discovered applications for tenant + + try { + Get-BetaDiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-applications + 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) + 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: + # Retrieve discovered applications for tenant + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-BetaManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-BetaManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaManualDiscoverApplicationsCsvTemplate -File $File + + # Below is a request that includes all optional parameters + # Send-BetaManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approval + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. + + # Get Approval + + try { + Get-BetaApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaApproval -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/approvals#get-approval + source: | + id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned. + try: + # Get Approval + + api_response = api_instance.get_approval(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approval(id) + print("The response of ApprovalsApi->get_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approvals + source: | + $Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) + $Filters = "filters=status 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: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-BetaApprovals + + # Below is a request that includes all optional parameters + # Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/approvals#get-approvals + source: | + 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 + + api_response = api_instance.get_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approvals(mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#create-source-app + source: | + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-BetaSourceApp -SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceApp -SourceAppCreateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#create-source-app + source: | + 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 + Result = source_app_create_dto.from_json(source_app_create_dto) + api_response = api_instance.create_source_app(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_app(Result) + print("The response of AppsApi->create_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-source-apps + 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) + $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) + $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) + $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: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-BetaAvailableSourceApps + + # Below is a request that includes all optional parameters + # Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-available-source-apps + 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) + 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 + + api_response = api_instance.list_available_source_apps() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_source_apps(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + $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) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # 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 + Result = request_body.from_json(request_body) + api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#delete-source-app + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + + # Delete source app by ID + + try { + Remove-BetaSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSourceApp -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#delete-source-app + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. + try: + # Delete source app by ID + + api_response = api_instance.delete_source_app(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source_app(id) + print("The response of AppsApi->delete_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#get-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + + # Get source app by ID + + try { + Get-BetaSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceApp -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#get-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + try: + # Get source app by ID + + api_response = api_instance.get_source_app(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_app(id) + print("The response of AppsApi->get_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#patch-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-BetaSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaSourceApp -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#patch-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch source app by ID + + api_response = api_instance.patch_source_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_source_app(id, Result) + print("The response of AppsApi->patch_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-access-profiles-for-source-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $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) + $Filters = "name eq "developer access profile"" # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-BetaAccessProfilesForSourceApp -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-access-profiles-for-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + 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 + + api_response = api_instance.list_access_profiles_for_source_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles_for_source_app(id, limit, offset, filters) + print("The response of AppsApi->list_access_profiles_for_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-source-app + 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) + $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) + $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) + $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: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled 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: **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) + + # List all source apps + + try { + Get-BetaAllSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-all-source-app + 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) + 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 + + api_response = api_instance.list_all_source_app() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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* + $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) + $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 all user apps + + try { + Get-BetaAllUserApps -Filters $Filters + + # Below is a request that includes all optional parameters + # Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-all-user-apps + source: | + 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* + 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 + + api_response = api_instance.list_all_user_apps(filters, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_user_apps(filters, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-assigned-source-app + 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) + $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) + $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) + $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: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-BetaAssignedSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-assigned-source-app + 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) + 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 + + api_response = api_instance.list_assigned_source_app() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_assigned_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-accounts-for-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $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) + $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 available accounts for user app + + try { + Get-BetaAvailableAccountsForUserApp -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-available-accounts-for-user-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app + 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 available accounts for user app + + api_response = api_instance.list_available_accounts_for_user_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_accounts_for_user_app(id, limit, count, offset) + print("The response of AppsApi->list_available_accounts_for_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#list-owned-user-apps + 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) + $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) + $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) + $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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-BetaOwnedUserApps + + # Below is a request that includes all optional parameters + # Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-owned-user-apps + 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) + 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 + + api_response = api_instance.list_owned_user_apps() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_owned_user_apps(limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#patch-user-app + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-BetaUserApp -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaUserApp -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#patch-user-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch user app by ID + + api_response = api_instance.patch_user_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_user_app(id, Result) + print("The response of AppsApi->patch_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/apps#update-source-apps-in-bulk + source: | + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-BetaSourceAppsInBulk + + # Below is a request that includes all optional parameters + # Update-BetaSourceAppsInBulk -SourceAppBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#update-source-apps-in-bulk + source: | + 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 + + api_instance.update_source_apps_in_bulk() + + # Below is a request that includes all optional parameters + # api_instance.update_source_apps_in_bulk(Result) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. + + # Get Auth Profile. + + try { + Get-BetaProfileConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get. + try: + # Get Auth Profile. + + api_response = api_instance.get_profile_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config(id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/auth-profile#patch-profile-config + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#patch-profile-config + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Auth Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_profile_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_profile_config(id, Result) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config-list + source: | + + # Get list of Auth Profiles. + + try { + Get-BetaProfileConfigList + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfigList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config-list + source: | + try: + # Get list of Auth Profiles. + + api_response = api_instance.get_profile_config_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config_list() + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CompleteCampaignOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-BetaCampaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-BetaCampaign -Id $Id -CompleteCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#complete-campaign + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. + complete_campaign_options = { + "autoCompleteAction" : "REVOKE" + } # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign + source: | + $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" + } + "@ + + # Create Campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-BetaCampaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign + source: | + 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 Campaign + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | 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 # 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 "Manager Campaign"" # 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* **status**: *eq, in* (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, created** (optional) + + # List Campaigns + + try { + Get-BetaActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-BetaActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "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" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-BetaCampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign-template + source: | + 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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-templates + 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 = "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, created, modified** (optional) + $Filters = "name eq "manager template"" # 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, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-BetaCampaignTemplates + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-BetaCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-BetaCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-BetaCampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-BetaCampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | 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" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-BetaCampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-BetaCampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaigns + source: | + $DeleteCampaignsRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest + Remove-BetaCampaigns -DeleteCampaignsRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaCampaigns -DeleteCampaignsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaigns + source: | + delete_campaigns_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # DeleteCampaignsRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = delete_campaigns_request.from_json(delete_campaigns_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + + # Get Campaign + + try { + Get-BetaCampaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaign -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. + try: + # Get Campaign + + api_response = api_instance.get_campaign(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. + $RequestBody = # SystemCollectionsHashtable[] | 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 + $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaCampaign -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaign -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign being modified. # str | ID of the campaign being modified. + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-BetaCampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-BetaCampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-Beta -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-Beta -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-BetaCampaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-BetaCampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. + + # Run Campaign Report + + try { + Start-BetaCampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-BetaCampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign-report + source: | + 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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of report to run. + try: + # Run Campaign Report + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-BetaGenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaGenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # 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: **target**: *eq, sw* **rights**: *ca* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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) + + # Permissions for Entitlement Certification Item + + try { + Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-item-permissions + source: | + 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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +- path: /certifications/{id}/tasks-pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-pending-tasks + source: | + $Id = "MyId" # String | The identity campaign certification ID + + # Pending Certification Tasks + + try { + Get-BetaIdentityCertificationPendingTasks -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationPendingTasks -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-pending-tasks + source: | + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Pending Certification Tasks + + api_response = api_instance.get_identity_certification_pending_tasks(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_pending_tasks(id) + print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) +- path: /certifications/{id}/tasks/{taskId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-task-status + source: | + $Id = "MyId" # String | The identity campaign certification ID + $TaskId = "MyTaskId" # String | The certification task ID + + # Certification Task Status + + try { + Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-task-status + source: | + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID + try: + # Certification Task Status + + api_response = api_instance.get_identity_certification_task_status(id, task_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_task_status(id, task_id) + print("The response of CertificationsApi->get_identity_certification_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification 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) + $Filters = "name eq "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, sw* **email**: *eq, 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, email** (optional) + + # List of Reviewers for certification + + try { + Get-BetaCertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaCertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certifications + source: | + $ReviewerIdentitiy = "MyReviewerIdentitiy" # String | The ID of reviewer identity. *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 = "MyFilters" # 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *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: **name, due, signed** (optional) + + # Certifications by IDs + + try { + Get-BetaCertifications + + # Below is a request that includes all optional parameters + # Get-BetaCertifications -ReviewerIdentitiy $ReviewerIdentitiy -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertifications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#list-certifications + source: | + reviewer_identitiy = 'reviewer_identitiy_example' # 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 = '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: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + 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: **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: + # Certifications by IDs + + api_response = api_instance.list_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#create-connector-rule + source: | + $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-BetaConnectorRule -ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaConnectorRule -ConnectorRuleCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#create-connector-rule + source: | + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | The connector rule to create + try: + # Create Connector Rule + Result = connector_rule_create_request.from_json(connector_rule_create_request) + api_response = api_instance.create_connector_rule(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_connector_rule(Result) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule-list + source: | + + # List Connector Rules + + try { + Get-BetaConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRuleList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule-list + source: | + try: + # List Connector Rules + + api_response = api_instance.get_connector_rule_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule_list() + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#delete-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete + + # Delete a Connector-Rule + + try { + Remove-BetaConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#delete-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete # str | ID of the connector rule to delete + try: + # Delete a Connector-Rule + + api_instance.delete_connector_rule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_connector_rule(id) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve + + # Connector-Rule by ID + + try { + Get-BetaConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve + try: + # Connector-Rule by ID + + api_response = api_instance.get_connector_rule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule(id) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#update-connector-rule + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update + $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 a Connector Rule + + try { + Update-BetaConnectorRule -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#update-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + try: + # Update a Connector Rule + + api_response = api_instance.update_connector_rule(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector_rule(id, Result) + print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#validate-connector-rule + source: | + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Confirm-BetaConnectorRule -SourceCode $Result + + # Below is a request that includes all optional parameters + # Confirm-BetaConnectorRule -SourceCode $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#validate-connector-rule + source: | + source_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | The code to validate + try: + # Validate Connector Rule + Result = source_code.from_json(source_code) + api_response = api_instance.validate_connector_rule(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.validate_connector_rule(Result) + print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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-BetaConnectorList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connectors#get-connector-list + source: | + 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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition + source: | + $CreateFormDefinitionRequest = @" + { + "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" + } ] + } + "@ + + # Creates a form definition. + + try { + New-BetaFormDefinition + + # Below is a request that includes all optional parameters + # New-BetaFormDefinition -CreateFormDefinitionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition + source: | + create_form_definition_request = { + "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. + + api_response = api_instance.create_form_definition() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition(Result) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-definitions-by-tenant + source: | + $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) + $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, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-definitions-by-tenant + source: | + 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. + + api_response = api_instance.search_form_definitions_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) +- path: /form-definitions/template + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-by-template + source: | + $CreateFormDefinitionRequest = @" + { + "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" + } ] + } + "@ + + # Create a form definition by template. + + try { + New-BetaFormDefinitionByTemplate + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionByTemplate -CreateFormDefinitionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-by-template + source: | + create_form_definition_request = { + "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: + # Create a form definition by template. + + api_response = api_instance.create_form_definition_by_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_by_template(Result) + print("The response of CustomFormsApi->create_form_definition_by_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-dynamic-schema + source: | + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-BetaFormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionDynamicSchema -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-dynamic-schema + source: | + 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. + + api_response = api_instance.create_form_definition_dynamic_schema() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_dynamic_schema(Result) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-file-request + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-file-request + source: | + 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. + + api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-instance + source: | + $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 + } + "@ + + # Creates a form instance. + + try { + New-BetaFormInstance + + # Below is a request that includes all optional parameters + # New-BetaFormInstance -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-instance + source: | + 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. + + api_response = api_instance.create_form_instance() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_instance(Result) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-instances-by-tenant + source: | + + # List form instances by tenant. + + try { + Search-BetaFormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormInstancesByTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-instances-by-tenant + source: | + try: + # List form instances by tenant. + + api_response = api_instance.search_form_instances_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_instances_by_tenant() + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#delete-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Deletes a form definition. + + try { + Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#delete-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Deletes a form definition. + + api_response = api_instance.delete_form_definition(form_definition_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_form_definition(form_definition_id) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-definition-by-key + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Return a form definition. + + try { + Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-definition-by-key + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Return a form definition. + + api_response = api_instance.get_form_definition_by_key(form_definition_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_definition_by_key(form_definition_id) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-definition + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $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}]"@ + + + # Patch a form definition. + + try { + Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-definition + source: | + 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) + 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. + + api_response = api_instance.patch_form_definition(form_definition_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_definition(form_definition_id, Result) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#export-form-definitions-by-tenant + source: | + $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) + $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, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#export-form-definitions-by-tenant + source: | + 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. + + api_response = api_instance.export_form_definitions_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Download definition file by fileId. + + try { + Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-file-from-s3 + source: | + 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. + + api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-by-key + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + + # Returns a form instance. + + try { + Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-by-key + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID + try: + # Returns a form instance. + + api_response = api_instance.get_form_instance_by_key(form_instance_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_by_key(form_instance_id) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-instance + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $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}}]"@ + + + # Patch a form instance. + + try { + Update-BetaFormInstance -FormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-BetaFormInstance -FormInstanceID $FormInstanceID -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-instance + source: | + 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) + 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. + + api_response = api_instance.patch_form_instance(form_instance_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_instance(form_instance_id, Result) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Download instance file by fileId. + + try { + Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-file + source: | + 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. + + api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#import-form-definitions + source: | + + + + + + + $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}}]"@ + + + # Import form definitions from export. + + try { + Import-BetaFormDefinitions + + # Below is a request that includes all optional parameters + # Import-BetaFormDefinitions -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#import-form-definitions + source: | + [{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) + 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. + + api_response = api_instance.import_form_definitions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_form_definitions(Result) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $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) + + # Retrieves dynamic data by element. + + try { + Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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. + + api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-pre-defined-select-options + source: | + + # List predefined select options. + + try { + Search-BetaPreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-BetaPreDefinedSelectOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-pre-defined-select-options + source: | + try: + # List predefined select options. + + api_response = api_instance.search_pre_defined_select_options() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_pre_defined_select_options() + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-forms#show-preview-data-source + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $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) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#show-preview-data-source + source: | + 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. + + api_response = api_instance.show_preview_data_source(form_definition_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_preview_data_source(form_definition_id, limit, filters, query, Result) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#create-custom-password-instructions + source: | + $CustomPasswordInstruction = @" + { + "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" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#create-custom-password-instructions + source: | + 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 + Result = custom_password_instruction.from_json(custom_password_instruction) + api_response = api_instance.create_custom_password_instructions(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_password_instructions(Result) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#delete-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-BetaCustomPasswordInstructions -PageId $PageId + + # Below is a request that includes all optional parameters + # Remove-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#delete-custom-password-instructions + source: | + page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. + 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 + + api_instance.delete_custom_password_instructions(page_id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_custom_password_instructions(page_id, locale) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#get-custom-password-instructions + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-BetaCustomPasswordInstructions -PageId $PageId + + # Below is a request that includes all optional parameters + # Get-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#get-custom-password-instructions + source: | + page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. + 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 + + api_response = api_instance.get_custom_password_instructions(page_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_password_instructions(page_id, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add metadata to an entitlement. + + try { + New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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. + try: + # Add metadata to an entitlement. + + api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove metadata from an entitlement. + + try { + Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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. + try: + # Remove metadata from an entitlement. + + api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + except Exception as e: + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + + # Get an entitlement + + try { + Get-BetaEntitlement -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlement -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement + source: | + id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID + try: + # Get an entitlement + + api_response = api_instance.get_entitlement(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement(id) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#patch-entitlement + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-BetaEntitlement -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaEntitlement -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#patch-entitlement + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch an entitlement + + api_response = api_instance.patch_entitlement(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_entitlement(id, Result) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement-request-config + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + + # Get Entitlement Request Config + + try { + Get-BetaEntitlementRequestConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementRequestConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement-request-config + source: | + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id + try: + # Get Entitlement Request Config + + api_response = api_instance.get_entitlement_request_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_request_config(id) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#put-entitlement-request-config + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $EntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#put-entitlement-request-config + source: | + id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID + 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 + } + } # EntitlementRequestConfig | + try: + # Replace Entitlement Request Config + Result = entitlement_request_config.from_json(entitlement_request_config) + api_response = api_instance.put_entitlement_request_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_entitlement_request_config(id, Result) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#import-entitlements-by-source + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-BetaEntitlementsBySource -Id $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlementsBySource -Id $Id -CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#import-entitlements-by-source + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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 + + api_response = api_instance.import_entitlements_by_source(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_by_source(id, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-children + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement 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 = "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: **id, name, created, modified, type, attribute, value, source.id** (optional) + $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, 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) + + # List of entitlements children + + try { + Get-BetaEntitlementChildren -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-children + source: | + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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 = '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 + + api_response = api_instance.list_entitlement_children(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_children(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-parents + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement 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 = "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: **id, name, created, modified, type, attribute, value, source.id** (optional) + $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, 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) + + # List of entitlements parents + + try { + Get-BetaEntitlementParents -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-parents + source: | + id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement 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 = '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 + + api_response = api_instance.list_entitlement_parents(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_parents(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlements + source: | + $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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) + $SegmentedForIdentity = "me" # String | 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) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | 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) + $IncludeUnsegmented = $true # Boolean | 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 # 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) + $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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $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, 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) + + # Gets a list of entitlements. + + try { + Get-BetaEntitlements + + # Below is a request that includes all optional parameters + # Get-BetaEntitlements -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-BetaEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlements + source: | + 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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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. + + api_response = api_instance.list_entitlements() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) +- path: /entitlements/reset/sources/{sourceId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#reset-source-entitlements + source: | + $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + + # Reset Source Entitlements + + try { + Reset-BetaSourceEntitlements -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Reset-BetaSourceEntitlements -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#reset-source-entitlements + source: | + source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset + try: + # Reset Source Entitlements + + api_response = api_instance.reset_source_entitlements(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reset_source_entitlements(source_id) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/entitlements#update-entitlements-in-bulk + source: | + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#update-entitlements-in-bulk + source: | + 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 + Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + api_instance.update_entitlements_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.update_entitlements_in_bulk(Result) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#create-workgroup + source: | + $WorkgroupDto = @" + { + "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" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-BetaWorkgroup -WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkgroup -WorkgroupDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#create-workgroup + source: | + 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. + Result = workgroup_dto.from_json(workgroup_dto) + api_response = api_instance.create_workgroup(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workgroup(Result) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroups + 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 = 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) + $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 "Test"" # 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, sw, in* **memberships.identityId**: *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, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-BetaWorkgroups + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroups -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroups + source: | + 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 + + api_response = api_instance.list_workgroups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Delete a Governance Group + + try { + Remove-BetaWorkgroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + try: + # Delete a Governance Group + + api_instance.delete_workgroup(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workgroup(id) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#get-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Get Governance Group by Id + + try { + Get-BetaWorkgroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#get-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + try: + # Get Governance Group by Id + + api_response = api_instance.get_workgroup(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workgroup(id) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#patch-workgroup + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-BetaWorkgroup -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroup -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#patch-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch a Governance Group + + api_response = api_instance.patch_workgroup(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workgroup(id, Result) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + + try: + # Remove members from Governance Group + Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroups-in-bulk + source: | + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroups-in-bulk + source: | + workgroup_bulk_delete_request = { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } # WorkgroupBulkDeleteRequest | + try: + # Delete Governance Group(s) + Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + api_response = api_instance.delete_workgroups_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroups_in_bulk(Result) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-connections + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $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 = 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) + $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 = "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) + + # List connections for Governance Group + + try { + Get-BetaConnections -WorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaConnections -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-connections + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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 + + api_response = api_instance.list_connections(workgroup_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_connections(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $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 = 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) + $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 = "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) + + # List Governance Group Members + + try { + Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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 + + api_response = api_instance.list_workgroup_members(workgroup_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroup_members(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/governance-groups#update-workgroup-members + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#update-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + + try: + # Add members to Governance Group + Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + api_response = api_instance.update_workgroup_members(workgroup_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workgroup_members(workgroup_id, Result) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Ignored Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + 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: + # Notification of Ignored Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_ignored_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_ignored_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-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) + $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 "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 + + try { + Get-BetaAccessRequestRecommendationsIgnoredItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsIgnoredItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + 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) + 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 of Ignored Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_ignored_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Requested Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + 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: + # Notification of Requested Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_requested_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_requested_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-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) + $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) + + # List of Requested Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsRequestedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsRequestedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + 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) + 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 = '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: **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 of Requested Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_requested_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + 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: + # Notification of Viewed Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-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) + $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) + + # List of Viewed Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsViewedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsViewedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + 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) + 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 = '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: **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 of Viewed Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_viewed_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Notification of Viewed Access Request Recommendations in Bulk + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + try: + # Notification of Viewed Access Request Recommendations in Bulk + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_items(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_items(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + $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) + $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) + + # Identity Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendations + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendations -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-BetaAccessRequestRecommendations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + 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 = '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: **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 + + api_response = api_instance.get_access_request_recommendations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#create-common-access + source: | + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-BetaCommonAccess -CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaCommonAccess -CommonAccessItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#create-common-access + source: | + 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 + Result = common_access_item_request.from_json(common_access_item_request) + api_response = api_instance.create_common_access(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_common_access(Result) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#get-common-access + 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 = "access.type eq "ROLE"" # 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (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, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-BetaCommonAccess + + # Below is a request that includes all optional parameters + # Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#get-common-access + source: | + 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 + + api_response = api_instance.get_common_access() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_common_access(offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#update-common-access-status-in-bulk + source: | + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#update-common-access-status-in-bulk + source: | + [sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + try: + # Bulk update common access status + Result = common_access_id_status.from_json(common_access_id_status) + api_response = api_instance.update_common_access_status_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_common_access_status_in_bulk(Result) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) +- path: /translation-catalogs/{catalog-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-message-catalogs#get-message-catalogs + source: | + $CatalogId = "recommender" # String | The ID of the message catalog. + + # Get Message catalogs + + try { + Get-BetaMessageCatalogs -CatalogId $CatalogId + + # Below is a request that includes all optional parameters + # Get-BetaMessageCatalogs -CatalogId $CatalogId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-message-catalogs#get-message-catalogs + source: | + catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog. + try: + # Get Message catalogs + + api_response = api_instance.get_message_catalogs(catalog_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_message_catalogs(catalog_id) + print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#export-outliers-zip + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-BetaOutliersZip + + # Below is a request that includes all optional parameters + # Export-BetaOutliersZip -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#export-outliers-zip + source: | + 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 + + api_response = api_instance.export_outliers_zip() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_outliers_zip(type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outlier-snapshots + 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) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # 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: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # 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: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-BetaIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutlierSnapshots -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outlier-snapshots + 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) + 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 + + api_response = api_instance.get_identity_outlier_snapshots() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outlier_snapshots(limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outliers + 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) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # 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: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-BetaIdentityOutliers + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutliers -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outliers + 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) + 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 + + api_response = api_instance.get_identity_outliers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outliers(limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-BetaLatestIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaLatestIdentityOutlierSnapshots -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + 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 + + api_response = api_instance.get_latest_identity_outlier_snapshots() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_latest_identity_outlier_snapshots(type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + + # Get identity outlier contibuting feature summary + + try { + Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId + + # Below is a request that includes all optional parameters + # Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id + try: + # Get identity outlier contibuting feature summary + + api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier 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) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # 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: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier 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) + 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 + + api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#ignore-identity-outliers + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#ignore-identity-outliers + source: | + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Ignore + Result = request_body.from_json(request_body) + api_instance.ignore_identity_outliers(Result) + + # Below is a request that includes all optional parameters + # api_instance.ignore_identity_outliers(Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $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) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # 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: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName + + # Below is a request that includes all optional parameters + # Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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 + 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 + + api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#un-ignore-identity-outliers + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#un-ignore-identity-outliers + source: | + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Unignore + Result = request_body.from_json(request_body) + api_instance.un_ignore_identity_outliers(Result) + + # Below is a request that includes all optional parameters + # api_instance.un_ignore_identity_outliers(Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $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) + + # Identity Outliers List + + try { + Get-BetaPeerGroupOutliers -Strategy $Strategy + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliers -Strategy $Strategy -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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. + 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 + + api_response = api_instance.get_peer_group_outliers(strategy, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers(strategy, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations + source: | + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns a Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-BetaRecommendations -RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-BetaRecommendations -RecommendationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations + source: | + 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 a Recommendation Based on Object + Result = recommendation_request_dto.from_json(recommendation_request_dto) + api_response = api_instance.get_recommendations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations(Result) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations-config + source: | + + # Get certification recommendation config values + + try { + Get-BetaRecommendationsConfig + + # Below is a request that includes all optional parameters + # Get-BetaRecommendationsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations-config + source: | + try: + # Get certification recommendation config values + + api_response = api_instance.get_recommendations_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations_config() + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#update-recommendations-config + source: | + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-BetaRecommendationsConfig -RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaRecommendationsConfig -RecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#update-recommendations-config + source: | + recommendation_config_dto = { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } # RecommendationConfigDto | + try: + # Update certification recommendation config values + Result = recommendation_config_dto.from_json(recommendation_config_dto) + api_response = api_instance.update_recommendations_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_recommendations_config(Result) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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 + 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. + + api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, Result) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-role-mining-sessions + source: | + $RoleMiningSessionDto = @" + { + "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" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-BetaRoleMiningSessions -RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-BetaRoleMiningSessions -RoleMiningSessionDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-role-mining-sessions + source: | + 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 + Result = role_mining_session_dto.from_json(role_mining_session_dto) + api_response = api_instance.create_role_mining_sessions(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_mining_sessions(Result) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-sessions + source: | + $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) + $Sorters = "createdBy,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: **createdBy, createdDate** (optional) + $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) + + # Retrieves all role mining sessions + + try { + Get-BetaRoleMiningSessions + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessions -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-sessions + source: | + 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 + + api_response = api_instance.get_role_mining_sessions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_sessions(filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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 + try: + # Export (download) details for a potential role in a role mining session + + api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + + # Export (download) details for a potential role in a role mining session + + try { + Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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 + try: + # Export (download) details for a potential role in a role mining session + + api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleExportRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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 + 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 + + api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Retrieve status of a potential role export job + + try { + Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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 + try: + # Retrieve status of a potential role export job + + api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-all-potential-role-summaries + source: | + $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) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved 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: **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 # 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) + + # Retrieves all potential role summaries + + try { + Get-BetaAllPotentialRoleSummaries + + # Below is a request that includes all optional parameters + # Get-BetaAllPotentialRoleSummaries -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-all-potential-role-summaries + source: | + 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 + + api_response = api_instance.get_all_potential_role_summaries() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_all_potential_role_summaries(sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) + print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $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) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $Sorters = "populariity" # 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: **popularity** (optional) + $Filters = "applicationName sw "AD"" # 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $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) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $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 = "MyFilters" # 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* (optional) + $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) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-identities-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + + # Retrieve potential role in session + + try { + Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role + source: | + 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 + try: + # Retrieve potential role in session + + api_response = api_instance.get_potential_role(session_id, potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $PatchPotentialRoleRequestInner = @"[{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}]"@ + + + # Update a potential role in session + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-potential-role + source: | + 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 + [{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] | + 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 in session + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $Filters = "applicationName sw "test"" # 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: **applicationName**: *sw* (optional) + $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) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-applications + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $Filters = "entitlementRef.name sw "test"" # 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: **entitlementRef.name**: *sw* (optional) + $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) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $Sorters = "-usageCount" # 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: **displayName, email, usageCount** (optional) + $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) + + # Retrieves potential role source usage + + try { + Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-summaries + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $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** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved 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: **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 # 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) + + # Retrieve session's potential role summaries + + try { + Get-BetaPotentialRoleSummaries -SessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSummaries -SessionId $SessionId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-summaries + source: | + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + 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: + # Retrieve session's potential role summaries + + api_response = api_instance.get_potential_role_summaries(session_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-potential-role + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + + # Retrieves a specific potential role + + try { + Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-potential-role + source: | + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id + try: + # Retrieves a specific potential role + + api_response = api_instance.get_role_mining_potential_role(potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_potential_role(potential_role_id) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-potential-role + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{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}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-potential-role + source: | + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + + # Get a role mining session + + try { + Get-BetaRoleMiningSession -SessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSession -SessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session + source: | + 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. + try: + # Get a role mining session + + api_response = api_instance.get_role_mining_session(session_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-session + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-session + source: | + 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 + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role_mining_session(session_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_session(session_id, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session-status + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + + # Get role mining session status state + + try { + Get-BetaRoleMiningSessionStatus -SessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessionStatus -SessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session-status + source: | + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + try: + # Get role mining session status state + + api_response = api_instance.get_role_mining_session_status(session_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session_status(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-saved-potential-roles + source: | + $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) + $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) + + # Retrieves all saved potential roles + + try { + Get-BetaSavedPotentialRoles + + # Below is a request that includes all optional parameters + # Get-BetaSavedPotentialRoles -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-saved-potential-roles + source: | + 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 + + api_response = api_instance.get_saved_potential_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_potential_roles(sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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 + 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 + Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/icons#delete-icon + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + + # Delete an icon + + try { + Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId + + # Below is a request that includes all optional parameters + # Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/icons#delete-icon + source: | + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + try: + # Delete an icon + + api_instance.delete_icon(object_type, object_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_icon(object_type, object_id) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/icons#set-icon + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image + + # Below is a request that includes all optional parameters + # Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/icons#set-icon + source: | + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + 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 + + api_response = api_instance.set_icon(object_type, object_id, image) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_icon(object_type, object_id, image) + print("The response of IconsApi->set_icon:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#delete-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Delete identity + + try { + Remove-BetaIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#delete-identity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Delete identity + + api_instance.delete_identity(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity(id) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Identity Details + + try { + Get-BetaIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-identity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Identity Details + + api_response = api_instance.get_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity(id) + print("The response of IdentitiesApi->get_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity-ownership-details + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + + # Get ownership details + + try { + Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-identity-ownership-details + source: | + identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. + try: + # Get ownership details + + api_response = api_instance.get_identity_ownership_details(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_ownership_details(identity_id) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignment + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + + # Role assignment details + + try { + Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignment + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id + try: + # Role assignment details + + api_response = api_instance.get_role_assignment(identity_id, assignment_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignment(identity_id, assignment_id) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignments + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-BetaRoleAssignments -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignments + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for + 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 + + api_response = api_instance.get_role_assignments(identity_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignments(identity_id, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#list-identities + source: | + $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) + $Sorters = "name,-cloudStatus" # 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, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | 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 = $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) + $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 Identities + + try { + Get-BetaIdentities + + # Below is a request that includes all optional parameters + # Get-BetaIdentities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#list-identities + source: | + 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 + + api_response = api_instance.list_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identities(filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) +- path: /identities/{identityId}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#reset-identity + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Reset an identity + + try { + Reset-BetaIdentity -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Reset-BetaIdentity -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#reset-identity + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Reset an identity + + api_instance.reset_identity(identity_id) + + # Below is a request that includes all optional parameters + # api_instance.reset_identity(identity_id) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#send-identity-verification-account-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#send-identity-verification-account-token + source: | + 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 + Result = send_account_verification_request.from_json(send_account_verification_request) + api_instance.send_identity_verification_account_token(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_identity_verification_account_token(id, Result) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#start-identities-invite + source: | + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#start-identities-invite + source: | + invite_identities_request = { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } # InviteIdentitiesRequest | + try: + # Invite identities to register + Result = invite_identities_request.from_json(invite_identities_request) + api_response = api_instance.start_identities_invite(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identities_invite(Result) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#start-identity-processing + source: | + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#start-identity-processing + source: | + process_identities_request = { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } # ProcessIdentitiesRequest | + try: + # Process a list of identityIds + Result = process_identities_request.from_json(process_identities_request) + api_response = api_instance.start_identity_processing(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identity_processing(Result) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identities#synchronize-attributes-for-identity + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + + # Attribute synchronization for single identity. + + try { + Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#synchronize-attributes-for-identity + source: | + identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id + try: + # Attribute synchronization for single identity. + + api_response = api_instance.synchronize_attributes_for_identity(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.synchronize_attributes_for_identity(identity_id) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#create-identity-attribute + source: | + $IdentityAttribute = @" + { + "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 + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-BetaIdentityAttribute -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityAttribute -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#create-identity-attribute + source: | + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.create_identity_attribute(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_attribute(Result) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#list-identity-attributes + source: | + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $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 Identity Attributes + + try { + Get-BetaIdentityAttributes + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#list-identity-attributes + source: | + 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 + + api_response = api_instance.list_identity_attributes() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_attributes(include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Delete Identity Attribute + + try { + Remove-BetaIdentityAttribute -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttribute -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + try: + # Delete Identity Attribute + + api_instance.delete_identity_attribute(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attribute(name) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#get-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Get Identity Attribute + + try { + Get-BetaIdentityAttribute -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttribute -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#get-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + try: + # Get Identity Attribute + + api_response = api_instance.get_identity_attribute(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_attribute(name) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#put-identity-attribute + source: | + $Name = "displayName" # String | The attribute's technical name. + $IdentityAttribute = @" + { + "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 + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#put-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.put_identity_attribute(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_identity_attribute(name, Result) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + identity_attribute_names = { + "ids" : [ "name", "displayName" ] + } # IdentityAttributeNames | + try: + # Bulk delete Identity Attributes + Result = identity_attribute_names.from_json(identity_attribute_names) + api_instance.delete_identity_attributes_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attributes_in_bulk(Result) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | 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 # 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) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshots -Id $Id + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshots -Id $Id -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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 + + api_response = api_instance.compare_identity_snapshots(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) +- path: /historical-identities/{id}/compare/{accessType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $AccessAssociated = $false # Boolean | 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" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (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) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 + 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 + + api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Get latest snapshot of identity + + try { + Get-BetaHistoricalIdentity -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + try: + # Get latest snapshot of identity + + api_response = api_instance.get_historical_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity(id) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity-events + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, 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) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-BetaHistoricalIdentityEvents -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentityEvents -Id $Id -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity-events + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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) + + 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 + + api_response = api_instance.get_historical_identity_events(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->get_historical_identity_events:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + + # Gets an identity snapshot at a given date + + try { + Get-BetaIdentitySnapshot -Id $Id -Date $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshot -Id $Id -Date $Date + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot + source: | + 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 + try: + # Gets an identity snapshot at a given date + + api_response = api_instance.get_identity_snapshot(id, var_date) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot(id, var_date) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot-summary + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (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) + + # Gets the summary for the event count for a specific identity + + try { + Get-BetaIdentitySnapshotSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotSummary -Id $Id -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot-summary + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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 + + api_response = api_instance.get_identity_snapshot_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) + print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-start-date + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Gets the start date of the identity + + try { + Get-BetaIdentityStartDate -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityStartDate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-start-date + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + try: + # Gets the start date of the identity + + api_response = api_instance.get_identity_start_date(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_start_date(id) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-historical-identities + source: | + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (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) + + # Lists all the identities + + try { + Get-BetaHistoricalIdentities + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentities -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-historical-identities + source: | + 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 + + api_response = api_instance.list_historical_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) + print("The response of IdentityHistoryApi->list_historical_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + $Filters = "source eq "DataScienceDataset"" # 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + $Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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) + $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) + $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 Access Items by Identity + + try { + Get-BetaIdentityAccessItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAccessItems -Id $Id -Type $Type -Filters $Filters -Sorters $Sorters -Query $Query -Limit $Limit -Count $Count -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-access-items + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + filters = 'source eq \"DataScienceDataset\"' # 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + query = 'Dr. Arden' # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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 + + api_response = api_instance.list_identity_access_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshot-access-items + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. + $Date = "2007-03-01T13:00:00Z" # String | Specified date. + $Type = "role" # String | Access item type. (optional) + + # Get Identity Access Items Snapshot + + try { + Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshot-access-items + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID. + var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date. + type = 'account' # str | Access item type. (optional) # str | Access item type. (optional) + try: + # Get Identity Access Items Snapshot + + api_response = api_instance.list_identity_snapshot_access_items(id, var_date, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshots + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-BetaIdentitySnapshots -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshots -Id $Id -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshots + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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 + + api_response = api_instance.list_identity_snapshots(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshots(id, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#create-identity-profile + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "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" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } + "@ + + # Create Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-BetaIdentityProfile -IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityProfile -IdentityProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#create-identity-profile + source: | + identity_profile = { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "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" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } # IdentityProfile | + try: + # Create Identity Profile + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 8c190e6787aa4ed9a90bd9d5344523fb" # 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 = "name,-priority" # 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-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#list-identity-profiles + 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) + filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Delete Identity Profile + + try { + Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Get Identity Profile + + try { + Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaIdentityProfiles -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfiles -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 8c190e6787aa4ed9a90bd9d5344523fb" # 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 = "name,-priority" # 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-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Export-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#export-identity-profiles + 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) + filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-default-identity-attribute-config + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + + # Default identity attribute config + + try { + Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID + try: + # Default identity attribute config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaIdentityProfiles -IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#show-generate-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-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#show-generate-identity-preview + source: | + 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.show_generate_identity_preview(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_generate_identity_preview(Result) + print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#sync-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +- path: /launchers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#create-launcher + source: | + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Create launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + New-BetaLauncher -LauncherRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaLauncher -LauncherRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#create-launcher + source: | + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to create a Launcher + try: + # Create launcher + Result = launcher_request.from_json(launcher_request) + api_response = api_instance.create_launcher(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_launcher(Result) + print("The response of LaunchersApi->create_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) +- path: /launchers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launchers + source: | + $Filters = "disabled 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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) + $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) + + # List all Launchers for tenant + + try { + Get-BetaLaunchers + + # Below is a request that includes all optional parameters + # Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#get-launchers + source: | + filters = 'disabled 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: **description**: *sw* **disabled**: *eq* **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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional) + limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10) + try: + # List all Launchers for tenant + + api_response = api_instance.get_launchers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_launchers(filters, next, limit) + print("The response of LaunchersApi->get_launchers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) +- path: /launchers/{launcherID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#delete-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted + + # Delete Launcher + + try { + Remove-BetaLauncher -LauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Remove-BetaLauncher -LauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#delete-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted + try: + # Delete Launcher + + api_instance.delete_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_launcher(launcher_id) + except Exception as e: + print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) +- path: /launchers/{launcherID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved + + # Get Launcher by ID + + try { + Get-BetaLauncher -LauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Get-BetaLauncher -LauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#get-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved + try: + # Get Launcher by ID + + api_response = api_instance.get_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_launcher(launcher_id) + print("The response of LaunchersApi->get_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) +- path: /launchers/{launcherID} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#put-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Replace Launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#put-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to replace Launcher + try: + # Replace Launcher + Result = launcher_request.from_json(launcher_request) + api_response = api_instance.put_launcher(launcher_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_launcher(launcher_id, Result) + print("The response of LaunchersApi->put_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) +- path: /beta/launchers/{launcherID}/launch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/launchers#start-launcher + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched + + # Launch a Launcher + + try { + Start-BetaLauncher -LauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Start-BetaLauncher -LauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#start-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched + try: + # Launch a Launcher + + api_response = api_instance.start_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_launcher(launcher_id) + print("The response of LaunchersApi->start_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#get-lifecycle-states + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + + # Get Lifecycle State + + try { + Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaMFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Remove-BetaMFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#delete-mfa-config + source: | + 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 + + api_response = api_instance.delete_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-BetaMFADuoConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaMFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaMFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-BetaMFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaMFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaMFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaMFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-BetaMFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSendToken -SendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSendToken -SendTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#create-send-token + source: | + send_token_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } # SendTokenRequest | + try: + # Create and send user token + Result = send_token_request.from_json(send_token_request) + api_response = api_instance.create_send_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_send_token(Result) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#ping-verification-status + source: | + 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 + Result = verification_poll_request.from_json(verification_poll_request) + api_response = api_instance.ping_verification_status(method, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_verification_status(method, Result) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaDuoVerifyRequest -DuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-duo-verify-request + source: | + duo_verification_request = { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + Result = duo_verification_request.from_json(duo_verification_request) + api_response = api_instance.send_duo_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_duo_verify_request(Result) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaKbaAnswers -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-BetaKbaAnswers -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-kba-answers + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Authenticate KBA provided MFA method + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.send_kba_answers(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_kba_answers(Result) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaOktaVerifyRequest -OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-okta-verify-request + source: | + okta_verification_request = { + "userId" : "example@mail.com" + } # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + Result = okta_verification_request.from_json(okta_verification_request) + api_response = api_instance.send_okta_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_okta_verify_request(Result) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaTokenAuthRequest -TokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTokenAuthRequest -TokenAuthRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-token-auth-request + source: | + token_auth_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + Result = token_auth_request.from_json(token_auth_request) + api_response = api_instance.send_token_auth_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_token_auth_request(Result) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "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" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = { + "body" : { + "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" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } # ManagedClientStatus | + try: + # Handle status request from client + Result = managed_client_status.from_json(managed_client_status) + api_response = api_instance.update_managed_client_status(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client_status(id, Result) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration + source: | + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster + source: | + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters + source: | + 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: + # Retrieve all Managed Clusters. + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-multi-host-integration + source: | + multi_host_integrations_create = { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + try: + # Create Multi-Host Integration + Result = multi_host_integrations_create.from_json(multi_host_integrations_create) + api_response = api_instance.create_multi_host_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_multi_host_integration(Result) + print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) +- path: /multihosts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations-list + 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 = "id eq 2c91808b6ef1d43e016efba0ce470904" # 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: **type**: *in* **forSubAdminId**: *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) + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) + + # List All Existing Multi-Host Integrations + + try { + Get-BetaMultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations-list + source: | + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *in* **forSubAdminId**: *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: **type**: *in* **forSubAdminId**: *in* (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) + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) + try: + # List All Existing Multi-Host Integrations + + api_response = api_instance.get_multi_host_integrations_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) +- path: /multihosts/{multihostId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + }"@ + + + # Create Sources Within Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + [sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + multi_host_integrations_create_sources = { + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + } # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + + try: + # Create Sources Within Multi-Host Integration + Result = multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) + api_instance.create_sources_within_multi_host(multihost_id, Result) + + # Below is a request that includes all optional parameters + # api_instance.create_sources_within_multi_host(multihost_id, Result) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) +- path: /multihosts/{multihostId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#delete-multi-host + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + + # Delete Multi-Host Integration + + try { + Remove-BetaMultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Remove-BetaMultiHost -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#delete-multi-host + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. + try: + # Delete Multi-Host Integration + + api_instance.delete_multi_host(multihost_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_multi_host(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) +- path: /multihosts/{multihostId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + + # Get Multi-Host Integration By ID + + try { + Get-BetaMultiHostIntegrations -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrations -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + try: + # Get Multi-Host Integration By ID + + api_response = api_instance.get_multi_host_integrations(multihost_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_integrations(multihost_id) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) +- path: /multihosts/{multihostId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#update-multi-host-sources + source: | + $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ + + + # Update Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#update-multi-host-sources + source: | + multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. + [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + + try: + # Update Multi-Host Integration + Result = update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) + api_instance.update_multi_host_sources(multihost_id, Result) + + # Below is a request that includes all optional parameters + # api_instance.update_multi_host_sources(multihost_id, Result) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-acct-aggregation-groups + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Account Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaAcctAggregationGroups -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-BetaAcctAggregationGroups -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-acct-aggregation-groups + source: | + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + try: + # Get Account Aggregation Groups Within Multi-Host Integration ID + + api_response = api_instance.get_acct_aggregation_groups(multihost_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_acct_aggregation_groups(multihost_id) + print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + try: + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + + # List Multi-Host Source Creation Errors + + try { + Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + try: + # List Multi-Host Source Creation Errors + + api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) +- path: /multihosts/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multihost-integration-types + source: | + + # List Multi-Host Integration Types + + try { + Get-BetaMultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaMultihostIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multihost-integration-types + source: | + try: + # List Multi-Host Integration Types + + api_response = api_instance.get_multihost_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multihost_integration_types() + print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) +- path: /multihosts/{multihostId}/sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-sources-within-multi-host + source: | + $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + $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 = "id eq 2c91808b6ef1d43e016efba0ce470904" # 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**: *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 Sources Within Multi-Host Integration + + try { + Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-sources-within-multi-host + source: | + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *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**: *in* (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) + try: + # List Sources Within Multi-Host Integration + + api_response = api_instance.get_sources_within_multi_host(multihost_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) + print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) +- path: /multihosts/{multihostId}/sources/testConnection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-connection-multi-host-sources + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + + # Test Configuration For Multi-Host Integration + + try { + Test-BetaConnectionMultiHostSources -MultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-BetaConnectionMultiHostSources -MultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-connection-multi-host-sources + source: | + multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + try: + # Test Configuration For Multi-Host Integration + + api_instance.test_connection_multi_host_sources(multihost_id) + + # Below is a request that includes all optional parameters + # api_instance.test_connection_multi_host_sources(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-source-connection-multihost + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration + $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + + # Test Configuration For Multi-Host Integration's Single Source + + try { + Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-source-connection-multihost + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration + try: + # Test Configuration For Multi-Host Integration's Single Source + + api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_approval_decision = { + "comment" : "comment" + } # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaNonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + $RequestedFor = "me" # 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 = "approvalStatus,firstName" # 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-BetaNonEmployeeRequests -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + requested_for = 'me' # 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 = 'approvalStatus,firstName' # 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 = $false # 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-BetaNonEmployeeSources + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # 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 Non-Employee Source Schema Attribute + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # 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 Non-Employee Source Schema Attribute + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete all custom schema attributes + + try { + Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-BetaNonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.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/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-BetaNonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # 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-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # 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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # 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-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk + source: | + $DeleteNonEmployeeRecordInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest + Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk + source: | + delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) + api_instance.delete_non_employee_record_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_record_in_bulk(Result) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-BetaNonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format + try: + # Delete Non-Employee Request + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-BetaNonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete Non-Employee Source's Schema Attribute + + try { + Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + try: + # Delete Non-Employee Source's Schema Attribute + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id + try: + # Get Schema Attribute Non-Employee Source + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Source's Schema Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 Non-Employee Source's Schema Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-BetaNonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-BetaNonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-BetaNonEmployeeRecords -Id $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + $Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) + $IncludeDetail = "include-detail=false" # String | 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-BetaNonEmployeeApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # 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-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) + + # Bulk upload status on source + + try { + Get-BetaNonEmployeeBulkUploadStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Bulk upload status on source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # 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-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-approval + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # 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-BetaNonEmployeeApproval + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-approval + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.list_non_employee_approval() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = { + "comment" : "comment" + } # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#create-domain-dkim + source: | + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-BetaDomainDkim -DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-BetaDomainDkim -DomainAddress $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-domain-dkim + source: | + domain_address = { + "domain" : "sailpoint.com" + } # DomainAddress | + try: + # Verify domain address via DKIM + Result = domain_address.from_json(domain_address) + api_response = api_instance.create_domain_dkim(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_domain_dkim(Result) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-dkim-attributes + source: | + + # Get DKIM Attributes + + try { + Get-BetaDkimAttributes + + # Below is a request that includes all optional parameters + # Get-BetaDkimAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-dkim-attributes + source: | + try: + # Get DKIM Attributes + + api_response = api_instance.get_dkim_attributes() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dkim_attributes() + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#create-notification-template + source: | + $TemplateDto = @" + { + "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" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-BetaNotificationTemplate -TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaNotificationTemplate -TemplateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-notification-template + source: | + 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 + Result = template_dto.from_json(template_dto) + api_response = api_instance.create_notification_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_notification_template(Result) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-templates + 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) + $Filters = "medium eq "EMAIL"" # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-BetaNotificationTemplates + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-templates + 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) + 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 + + api_response = api_instance.list_notification_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_templates(limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#create-verified-from-address + source: | + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-BetaVerifiedFromAddress -EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-BetaVerifiedFromAddress -EmailStatusDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-verified-from-address + source: | + email_status_dto = { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } # EmailStatusDto | + try: + # Create Verified From Address + Result = email_status_dto.from_json(email_status_dto) + api_response = api_instance.create_verified_from_address(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_verified_from_address(Result) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-from-addresses + 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 = "email eq "john.doe@company.com"" # 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: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # 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: **email** (optional) + + # List From Addresses + + try { + Get-BetaFromAddresses + + # Below is a request that includes all optional parameters + # Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-from-addresses + 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) + 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 + + api_response = api_instance.list_from_addresses() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-notification-templates-in-bulk + source: | + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#delete-notification-templates-in-bulk + source: | + [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) + api_instance.delete_notification_templates_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_notification_templates_in_bulk(Result) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-verified-from-address + source: | + $Id = "MyId" # String | + + # Delete Verified From Address + + try { + Remove-BetaVerifiedFromAddress -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaVerifiedFromAddress -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#delete-verified-from-address + source: | + id = 'id_example' # str | # str | + try: + # Delete Verified From Address + + api_instance.delete_verified_from_address(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_verified_from_address(id) + except Exception as e: + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) +- path: /mail-from-attributes/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-mail-from-attributes + source: | + $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + + # Get MAIL FROM Attributes + + try { + Get-BetaMailFromAttributes -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaMailFromAttributes -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-mail-from-attributes + source: | + identity_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 + try: + # Get MAIL FROM Attributes + + api_response = api_instance.get_mail_from_attributes(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mail_from_attributes(identity_id) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notification-template + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + + # Get Notification Template By Id + + try { + Get-BetaNotificationTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-notification-template + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template + try: + # Get Notification Template By Id + + api_response = api_instance.get_notification_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notification_template(id) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notifications-template-context + source: | + + # Get Notification Template Context + + try { + Get-BetaNotificationsTemplateContext + + # Below is a request that includes all optional parameters + # Get-BetaNotificationsTemplateContext + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-notifications-template-context + source: | + try: + # Get Notification Template Context + + api_response = api_instance.get_notifications_template_context() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notifications_template_context() + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-preferences + source: | + $Key = "cloud_manual_work_item_summary" # String | The notification key. + + # List Notification Preferences for tenant. + + try { + Get-BetaNotificationPreferences -Key $Key + + # Below is a request that includes all optional parameters + # Get-BetaNotificationPreferences -Key $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-preferences + source: | + key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key. + try: + # List Notification Preferences for tenant. + + api_response = api_instance.list_notification_preferences(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_preferences(key) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-template-defaults + 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) + $Filters = "key eq "cloud_manual_work_item_summary"" # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-BetaNotificationTemplateDefaults + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-template-defaults + 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) + 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 + + api_response = api_instance.list_notification_template_defaults() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_template_defaults(limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#put-mail-from-attributes + source: | + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-BetaMailFromAttributes -MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaMailFromAttributes -MailFromAttributesDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#put-mail-from-attributes + source: | + mail_from_attributes_dto = { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } # MailFromAttributesDto | + try: + # Change MAIL FROM domain + Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) + api_response = api_instance.put_mail_from_attributes(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_mail_from_attributes(Result) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/notifications#send-test-notification + source: | + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-BetaTestNotification -SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaTestNotification -SendTestNotificationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#send-test-notification + source: | + send_test_notification_request_dto = { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } # SendTestNotificationRequestDto | + try: + # Send Test Notification + Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) + api_instance.send_test_notification(Result) + + # Below is a request that includes all optional parameters + # api_instance.send_test_notification(Result) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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", "http://localhost:67890" ], + "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-BetaOauthClient -CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaOauthClient -CreateOAuthClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#create-oauth-client + source: | + 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", "http://localhost:67890" ], + "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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaOauthClients + + # Below is a request that includes all optional parameters + # Get-BetaOauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#delete-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-BetaOauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaOauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#get-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-BetaOauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaOauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaOauthClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/org-config#get-org-config + source: | + + # Get Org configuration settings + + try { + Get-BetaOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#get-org-config + source: | + try: + # Get Org configuration settings + + api_response = api_instance.get_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_org_config() + print("The response of OrgConfigApi->get_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/org-config#patch-org-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an Org configuration property + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOrgConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOrgConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#patch-org-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Patch an Org configuration property + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_org_config(Result) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/org-config#get-valid-time-zones + source: | + + # Get list of time zones + + try { + Get-BetaValidTimeZones + + # Below is a request that includes all optional parameters + # Get-BetaValidTimeZones + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#get-valid-time-zones + source: | + try: + # Get list of time zones + + api_response = api_instance.get_valid_time_zones() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_valid_time_zones() + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-BetaPasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-BetaPasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaPasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Get-BetaPasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Send-BetaPasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#create-digit-token + source: | + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-BetaDigitToken -PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-BetaDigitToken -PasswordDigitTokenReset $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#create-digit-token + source: | + password_digit_token_reset = { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } # PasswordDigitTokenReset | + try: + # Generate a digit token + Result = password_digit_token_reset.from_json(password_digit_token_reset) + api_response = api_instance.create_digit_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_digit_token(Result) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#get-identity-password-change-status + source: | + $Id = "MyId" # String | + + # Get Password Change Request Status + + try { + Get-BetaIdentityPasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityPasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#get-identity-password-change-status + source: | + id = 'id_example' # str | # str | + try: + # Get Password Change Request Status + + api_response = api_instance.get_identity_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_password_change_status(id) + print("The response of PasswordManagementApi->get_identity_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-management#set-identity-password + source: | + $PasswordChangeRequest = @" + { + "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==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-BetaIdentityPassword -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaIdentityPassword -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#set-identity-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_identity_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_identity_password(Result) + print("The response of PasswordManagementApi->set_identity_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordPolicy -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordPolicies + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/password-policies#delete-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-BetaPasswordPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordPolicyById -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordSyncGroup -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordSyncGroup -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-BetaPersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#delete-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-BetaPersonalAccessToken -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.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/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#get-public-identity-config + source: | + + # Get Public Identity Config + + try { + Get-BetaPublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-BetaPublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get Public Identity Config + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 Public Identity Config + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/public-identities-config#update-public-identity-config + source: | + 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 Public Identity Config + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaRequestableObjects + + # Below is a request that includes all optional parameters + # Get-BetaRequestableObjects -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-BetaRequestableObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/requestable-objects#list-requestable-objects + source: | + 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.beta.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. Support for additional types may be added in the future without notice. (optional) + + types = [sailpoint.beta.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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#create-role-insight-requests + source: | + + # Generate insights for roles + + try { + New-BetaRoleInsightRequests + + # Below is a request that includes all optional parameters + # New-BetaRoleInsightRequests + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#create-role-insight-requests + source: | + try: + # Generate insights for roles + + api_response = api_instance.create_role_insight_requests() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_insight_requests() + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#download-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "identitiesWithAccess" # 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # 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* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#download-role-insights-entitlements-changes + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.download_role_insights_entitlements_changes(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $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) + $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 sw "Jan"" # 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* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-entitlement-changes-identities + source: | + 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 + 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) + + api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insight + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + + # Get a single role insight + + try { + Get-BetaRoleInsight -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsight -InsightId $InsightId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insight + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + try: + # Get a single role insight + + api_response = api_instance.get_role_insight(insight_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insight(insight_id) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights + 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) + $Sorters = "numberOfUpdates" # 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-BetaRoleInsights + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsights -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights + source: | + 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 + + api_response = api_instance.get_role_insights() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights(offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-current-entitlements + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Filters = "name sw "r"" # 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* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-current-entitlements + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.get_role_insights_current_entitlements(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_current_entitlements(insight_id, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-entitlements-changes + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $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: **identitiesWithAccess, name** (optional) + $Filters = "name sw "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: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-entitlements-changes + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.get_role_insights_entitlements_changes(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-requests + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + + # Returns metadata from prior request. + + try { + Get-BetaRoleInsightsRequests -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsRequests -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-requests + source: | + id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id + try: + # Returns metadata from prior request. + + api_response = api_instance.get_role_insights_requests(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_requests(id) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-summary + source: | + + # Get role insights summary information + + try { + Get-BetaRoleInsightsSummary + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsSummary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-summary + source: | + try: + # Get role insights summary information + + api_response = api_instance.get_role_insights_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_summary() + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaRole -Role $Result + + # Below is a request that includes all optional parameters + # New-BetaRole -Role $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaRoles + + # Below is a request that includes all optional parameters + # Get-BetaRoles -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-BetaRoles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#delete-bulk-roles + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#delete-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-BetaRole -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaRole -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#get-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-BetaRole -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRole -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaRole -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRole -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + + # Identities assigned a Role + + try { + Get-BetaRoleAssignedIdentities -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role-assigned-identities + source: | + 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: + # Identities assigned a Role + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $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 = "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 + + try { + Get-BetaRoleEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role-entitlements + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role + 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* (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 + + api_response = api_instance.get_role_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_entitlements(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration + source: | + $SimIntegrationDetails = @" + { + "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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-BetaSIMIntegration -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#create-sim-integration + source: | + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.create_sim_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sim_integration(Result) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations + source: | + + # List the existing SIM integrations. + + try { + Get-BetaSIMIntegrations + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegrations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integrations + source: | + try: + # List the existing SIM integrations. + + api_response = api_instance.get_sim_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integrations() + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + + # Delete a SIM integration + + try { + Remove-BetaSIMIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSIMIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#delete-sim-integration + source: | + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + try: + # Delete a SIM integration + + api_instance.delete_sim_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_sim_integration(id) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + + # Get a SIM integration details. + + try { + Get-BetaSIMIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integration + source: | + id = '12345' # str | The id of the integration. # str | The id of the integration. + try: + # Get a SIM integration details. + + api_response = api_instance.get_sim_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integration(id) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSIMAttributes -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-sim-attributes + source: | + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_sim_attributes(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sim_attributes(id, Result) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $SimIntegrationDetails = @" + { + "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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#put-sim-integration + source: | + id = '12345' # str | The id of the integration. # str | The id of the integration. + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.put_sim_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sim_integration(id, Result) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-before-provisioning-rule + source: | + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_before_provisioning_rule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_before_provisioning_rule(id, Result) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "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" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-BetaSodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (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, description** (optional) + + # List SOD policies + + try { + Get-BetaSodPolicies + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # 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. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) + try: + # Delete SOD policy by ID + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy by ID + + try { + Get-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD policy by ID + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. + $RequestBody = # SystemCollectionsHashtable[] | 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 + $RequestBody = @"[{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}]}}]"@ + + + # Patch a SOD policy + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSodPolicy -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSodPolicy -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#patch-sod-policy + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + request_body = [{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[object] | 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 + request_body = [{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[object] | 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 a SOD policy + Result = request_body.from_json(request_body) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "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" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-BetaSodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#put-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-BetaSodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy schedule + + try { + Get-BetaSodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD policy schedule + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#put-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } # SodPolicySchedule | + try: + # Update SOD Policy schedule + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Download custom violation report + + try { + Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-BetaSodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-BetaSodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD violation report status + + try { + Get-BetaSodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-status + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD violation report status + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } + "@ + + # Runs all policies for org + + try { + Start-BetaSodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-BetaSodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-all-policies-for-org + source: | + multi_policy_request = { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-BetaSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-BetaSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "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" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-BetaPredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + export_payload = { + "description" : "Export Job 1 Test" + } # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + Result = export_payload.from_json(export_payload) + api_response = api_instance.export_sp_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_sp_config(Result) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + 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. + + api_response = api_instance.get_sp_config_export(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + 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 + + api_response = api_instance.get_sp_config_export_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + 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 + + api_response = api_instance.get_sp_config_import(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + 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 + + api_response = api_instance.get_sp_config_import_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + 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.beta.ImportOptions() # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + api_response = api_instance.import_sp_config(data, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # Get config object details + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + try: + # Get config object details + + api_response = api_instance.list_sp_config_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + search_attribute_config = { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } # SearchAttributeConfig | + try: + # Create Extended Search Attributes + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + try: + # List Extended Search Attributes + + api_response = api_instance.get_search_attribute_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_instance.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/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + api_response = api_instance.get_single_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSegment -Segment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSegment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration + source: | + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + 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 = "id eq 2c91808b6ef1d43e016efba0ce470904" # 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-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integration_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.beta.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 = "-date" # 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: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "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" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-BetaProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#create-source + source: | + $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" + } + "@ + $ProvisionAsCsv = $false # Boolean | 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) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-BetaSource -Source $Result + + # Below is a request that includes all optional parameters + # New-BetaSource -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 "Employees"" # 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, 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* **modified**: *eq* **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" # 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: **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) + $ForSubadmin = "name" # String | 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) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-BetaSources + + # Below is a request that includes all optional parameters + # Get-BetaSources -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-BetaSources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#list-sources + 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) + 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* **modified**: *eq* **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* **modified**: *eq* **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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-BetaSourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.beta.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-BetaSourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Beta -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Beta -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete(id) + print("The response of SourcesApi->delete:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete: %s\n" % e) +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-BetaSource -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSource -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | 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" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-BetaSource -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-BetaSource -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSource -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSource -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +- path: /sources/{sourceId}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-accounts-async + source: | + $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id + + # Remove All Accounts in a Source + + try { + Remove-BetaAccountsAsync -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaAccountsAsync -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-accounts-async + source: | + source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id + try: + # Remove All Accounts in a Source + + api_response = api_instance.delete_accounts_async(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_accounts_async(source_id) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-native-change-detection-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Delete Native Change Detection Configuration + + try { + Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Delete Native Change Detection Configuration + + api_instance.delete_native_change_detection_config(source_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_native_change_detection_config(source_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-native-change-detection-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Native Change Detection Configuration + + try { + Get-BetaNativeChangeDetectionConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNativeChangeDetectionConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Native Change Detection Configuration + + api_response = api_instance.get_native_change_detection_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_native_change_detection_config(source_id) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-native-change-detection-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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 + Result = native_change_detection_config.from_json(native_change_detection_config) + api_response = api_instance.put_native_change_detection_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_native_change_detection_config(source_id, Result) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Delete Provisioning Policy by UsageType + + try { + Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Get Provisioning Policy by UsageType + + try { + Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + $ProvisioningPolicyDto = @" + { + "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" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.beta.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Delete Source Schema by ID + + try { + Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Get Source Schema by ID + + try { + Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source-schema + source: | + 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.beta.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{op=replace, path=/displayAttribute, value={new-display-attribute=null}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /sources/{sourceId}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-correlation-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-BetaCorrelationConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaCorrelationConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-correlation-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + api_response = api_instance.get_correlation_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_correlation_config(source_id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) +- path: /sources/{sourceId}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-correlation-config + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "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" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-correlation-config + source: | + source_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 + Result = correlation_config.from_json(correlation_config) + api_response = api_instance.put_correlation_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_correlation_config(source_id, Result) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) +- path: /sources/{sourceId}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-accounts-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-BetaSourceAccountsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceAccountsSchema -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-accounts-schema + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_source_accounts_schema(source_id) + + # Below is a request that includes all optional parameters + # api_instance.get_source_accounts_schema(source_id) + except Exception as e: + print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-accounts-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-BetaSourceAccountsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceAccountsSchema -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-accounts-schema + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_source_accounts_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_accounts_schema(source_id, file) + print("The response of SourcesApi->import_source_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Attribute Sync Config + + try { + Get-BetaSourceAttrSyncConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAttrSyncConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-attr-sync-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Attribute Sync Config + + api_response = api_instance.get_source_attr_sync_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_attr_sync_config(id) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-attr-sync-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $AttrSyncSourceConfig = @" + { + "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" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source-attr-sync-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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 + Result = attr_sync_source_config.from_json(attr_sync_source_config) + api_response = api_instance.put_source_attr_sync_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_attr_sync_config(id, Result) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-config + source: | + $Id = "MyId" # 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-BetaSourceConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceConfig -Id $Id -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-config + source: | + id = 'id_example' # str | The Source id # str | The Source id + locale = 'locale_example' # 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 + + api_response = api_instance.get_source_config(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_config(id, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) +- path: /sources/{sourceId}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlement-request-config + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Get Source Entitlement Request Configuration + + try { + Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlement-request-config + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Get Source Entitlement Request Configuration + + api_response = api_instance.get_source_entitlement_request_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_entitlement_request_config(source_id) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-entitlement-request-config + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source-entitlement-request-config + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + 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 + Result = source_entitlement_request_config.from_json(source_entitlement_request_config) + api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlements-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-BetaSourceEntitlementsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlements-schema + source: | + source_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 + + api_instance.get_source_entitlements_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_source_entitlements_schema(source_id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-entitlements-schema + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-BetaSourceEntitlementsSchema -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-entitlements-schema + source: | + source_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 + + api_response = api_instance.import_source_entitlements_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_entitlements_schema(source_id, schema_name, file) + print("The response of SourcesApi->import_source_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-accounts + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-BetaAccounts -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaAccounts -SourceId $SourceId -File $File -DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-accounts + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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 + + api_response = api_instance.import_accounts(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts(source_id, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) +- path: /sources/{sourceId}/load-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-entitlements + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Entitlement Aggregation + + try { + Import-BetaEntitlements -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaEntitlements -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-entitlements + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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: + # Entitlement Aggregation + + api_response = api_instance.import_entitlements(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements(source_id, file) + print("The response of SourcesApi->import_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-connector-file + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-BetaSourceConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-connector-file + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_source_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_connector_file(source_id, file) + print("The response of SourcesApi->import_source_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) +- path: /sources/{sourceId}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#import-uncorrelated-accounts + source: | + $SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-BetaUncorrelatedAccounts -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaUncorrelatedAccounts -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-uncorrelated-accounts + source: | + source_id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Process Uncorrelated Accounts + + api_response = api_instance.import_uncorrelated_accounts(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_uncorrelated_accounts(source_id, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#peek-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 + Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#peek-resource-objects + source: | + 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 + Result = resource_objects_request.from_json(resource_objects_request) + api_response = api_instance.peek_resource_objects(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.peek_resource_objects(source_id, Result) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#ping-cluster + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-BetaCluster -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-BetaCluster -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#ping-cluster + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Ping cluster for source connector + + api_response = api_instance.ping_cluster(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_cluster(source_id) + print("The response of SourcesApi->ping_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) +- path: /sources/{sourceId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#sync-attributes-for-source + source: | + $SourceId = "MySourceId" # String | The Source id + + # Synchronize single source attributes. + + try { + Sync-BetaAttributesForSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Sync-BetaAttributesForSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#sync-attributes-for-source + source: | + source_id = 'source_id_example' # str | The Source id # str | The Source id + try: + # Synchronize single source attributes. + + api_response = api_instance.sync_attributes_for_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_attributes_for_source(source_id) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-configuration + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-BetaSourceConfiguration -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConfiguration -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#test-source-configuration + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Test configuration for source connector + + api_response = api_instance.test_source_configuration(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_configuration(source_id) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-connection + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-BetaSourceConnection -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnection -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#test-source-connection + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + try: + # Check connection for source connector. + + api_response = api_instance.test_source_connection(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection(source_id) + print("The response of SourcesApi->test_source_connection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "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" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaSedBatchStats -BatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-BetaSedBatchStats -BatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + api_response = api_instance.get_sed_batch_stats(batch_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batches + source: | + + # List Sed Batch Request + + try { + Get-BetaSedBatches + + # Below is a request that includes all optional parameters + # Get-BetaSedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batches + source: | + try: + # List Sed Batch Request + + api_response = api_instance.get_sed_batches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-BetaSedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-BetaSedBatchRequest -SedBatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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 + + api_response = api_instance.submit_sed_batch_request() + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_batch_request(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#list-seds + source: | + $Limit = limit=25 # Int64 | 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) + $Filters = "displayName co "Read and Write"" # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # 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: **displayName, sourceName, status** (optional) + $Count = $false # 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + $CountOnly = $false # 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | 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) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + + # List Suggested Entitlement Descriptions + + try { + Get-BetaSeds + + # Below is a request that includes all optional parameters + # Get-BetaSeds -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#list-seds + source: | + limit = limit=25 # int | 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) # int | 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) + 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 = count=true # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + count_only = count-only=true # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + requested_by_anyone = requested-by-anyone=true # 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) # 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) + show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) + try: + # List Suggested Entitlement Descriptions + + api_response = api_instance.list_seds() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#patch-sed + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-BetaSed -Id $Id -SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSed -Id $Id -SedPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#patch-sed + source: | + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + [sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + try: + # Patch Suggested Entitlement Description + Result = sed_patch.from_json(sed_patch) + api_response = api_instance.patch_sed(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sed(id, Result) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-approval + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-BetaSedApproval -SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedApproval -SedApproval $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-approval + source: | + [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + try: + # Submit Bulk Approval Request + Result = sed_approval.from_json(sed_approval) + api_response = api_instance.submit_sed_approval(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_approval(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-assignment + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-BetaSedAssignment -SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedAssignment -SedAssignment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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 + Result = sed_assignment.from_json(sed_assignment) + api_response = api_instance.submit_sed_assignment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_assignment(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Delete Object Tags + + try { + Remove-BetaTaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Get Tagged Object + + try { + Get-BetaTaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Remove-BetaTagsToManyObject -BulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-BetaTagsToManyObject -BulkTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tags-to-many-object + source: | + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Remove Tags from Multiple Objects + Result = bulk_tagged_object.from_json(bulk_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 = "tagName eq "BU_FINANCE"" # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-BetaTaggedObjects + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-BetaTagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 = "objectRef.id 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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-BetaTaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Set-BetaTagsToManyObjects -BulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagsToManyObjects -BulkTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tags-to-many-objects + source: | + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + Result = bulk_tagged_object.from_json(bulk_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +- path: /tags + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#create-tag + source: | + $Tag = @" + { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "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" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } + "@ + + # Create Tag + + try { + $Result = ConvertFrom-JsonToTag -Json $Tag + New-BetaTag -Tag $Result + + # Below is a request that includes all optional parameters + # New-BetaTag -Tag $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#create-tag + source: | + tag = { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "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" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } # Tag | + try: + # Create Tag + Result = tag.from_json(tag) + api_response = api_instance.create_tag(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_tag(Result) + print("The response of TagsApi->create_tag:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->create_tag: %s\n" % e) +- path: /tags + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#list-tags + 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 "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # 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,-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: **id, name, created, modified** (optional) + + # List Tags + + try { + Get-BetaTags + + # Below is a request that includes all optional parameters + # Get-BetaTags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#list-tags + 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) + filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # 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,-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** (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** (optional) + try: + # List Tags + + api_response = api_instance.list_tags() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tags(limit, offset, count, filters, sorters) + print("The response of TagsApi->list_tags:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->list_tags: %s\n" % e) +- path: /tags/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#delete-tag-by-id + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. + + # Delete Tag + + try { + Remove-BetaTagById -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTagById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#delete-tag-by-id + source: | + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete. + try: + # Delete Tag + + api_instance.delete_tag_by_id(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tag_by_id(id) + except Exception as e: + print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) +- path: /tags/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tags#get-tag-by-id + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. + + # Get Tag By Id + + try { + Get-BetaTagById -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTagById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#get-tag-by-id + source: | + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get Tag By Id + + api_response = api_instance.get_tag_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tag_by_id(id) + print("The response of TagsApi->get_tag_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-task-headers + 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) + + # Retrieve Pending Task List Headers + + try { + Get-BetaPendingTaskHeaders + + # Below is a request that includes all optional parameters + # Get-BetaPendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-task-headers + source: | + 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 + + api_instance.get_pending_task_headers() + + # Below is a request that includes all optional parameters + # api_instance.get_pending_task_headers(offset, limit, count) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-tasks + 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) + + # Retrieve Pending Task Status List + + try { + Get-BetaPendingTasks + + # Below is a request that includes all optional parameters + # Get-BetaPendingTasks -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-tasks + source: | + 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 + + api_response = api_instance.get_pending_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_tasks(offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + + # Get Task Status by ID + + try { + Get-BetaTaskStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status + source: | + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + try: + # Get Task Status by ID + + api_response = api_instance.get_task_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status(id) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#update-task-status + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#update-task-status + source: | + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + try: + # Update Task Status by ID + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_task_status(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_task_status(id, Result) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status-list + 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 = "completionStatus eq "Success"" # 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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** (optional) + + # Retrieve Task Status List + + try { + Get-BetaTaskStatusList + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status-list + 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) + 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 + + api_response = api_instance.get_task_status_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status_list(limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/tenant#get-tenant + source: | + + # Get Tenant Information. + + try { + Get-BetaTenant + + # Below is a request that includes all optional parameters + # Get-BetaTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tenant#get-tenant + source: | + try: + # Get Tenant Information. + + api_response = api_instance.get_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-BetaTransform -Transform $Result + + # Below is a request that includes all optional parameters + # New-BetaTransform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # 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: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-BetaTransforms + + # Below is a request that includes all optional parameters + # Get-BetaTransforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-BetaTransform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTransform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-BetaTransform -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaTransform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-BetaTransform -Id $Id + + # Below is a request that includes all optional parameters + # Update-BetaTransform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#complete-trigger-invocation + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#complete-trigger-invocation + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. + complete_invocation = { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } # CompleteInvocation | + try: + # Complete Trigger Invocation + Result = complete_invocation.from_json(complete_invocation) + api_instance.complete_trigger_invocation(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.complete_trigger_invocation(id, Result) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#create-subscription + source: | + $SubscriptionPostRequest = @" + { + "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 + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-BetaSubscription -SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSubscription -SubscriptionPostRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#create-subscription + source: | + 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 + Result = subscription_post_request.from_json(subscription_post_request) + api_response = api_instance.create_subscription(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_subscription(Result) + print("The response of TriggersApi->create_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#list-subscriptions + 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 "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # 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* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # 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: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-BetaSubscriptions + + # Below is a request that includes all optional parameters + # Get-BetaSubscriptions -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-subscriptions + 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) + 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 + + api_response = api_instance.list_subscriptions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_subscriptions(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#delete-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + + # Delete a Subscription + + try { + Remove-BetaSubscription -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSubscription -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#delete-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + try: + # Delete a Subscription + + api_instance.delete_subscription(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_subscription(id) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#patch-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#patch-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch + [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + try: + # Patch a Subscription + Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) + api_response = api_instance.patch_subscription(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_subscription(id, Result) + print("The response of TriggersApi->patch_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#update-subscription + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $SubscriptionPutRequest = @" + { + "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 + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#update-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + 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 + Result = subscription_put_request.from_json(subscription_put_request) + api_response = api_instance.update_subscription(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_subscription(id, Result) + print("The response of TriggersApi->update_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#list-trigger-invocation-status + 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 = "triggerId eq "idn:access-request-dynamic-approver"" # 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-BetaTriggerInvocationStatus + + # Below is a request that includes all optional parameters + # Get-BetaTriggerInvocationStatus -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-trigger-invocation-status + 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) + 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 + + api_response = api_instance.list_trigger_invocation_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_trigger_invocation_status(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#list-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) + $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 "idn:access-request-post-approval"" # 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, ge, le* (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: **id, name** (optional) + + # List Triggers + + try { + Get-BetaTriggers + + # Below is a request that includes all optional parameters + # Get-BetaTriggers -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-triggers + 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) + 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 + + api_response = api_instance.list_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_triggers(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#start-test-trigger-invocation + source: | + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-BetaTestTriggerInvocation -TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-BetaTestTriggerInvocation -TestInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#start-test-trigger-invocation + source: | + 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 + Result = test_invocation.from_json(test_invocation) + api_response = api_instance.start_test_trigger_invocation(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_test_trigger_invocation(Result) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/triggers#test-subscription-filter + source: | + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#test-subscription-filter + source: | + validate_filter_input_dto = { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } # ValidateFilterInputDto | + try: + # Validate a Subscription Filter + Result = validate_filter_input_dto.from_json(validate_filter_input_dto) + api_response = api_instance.test_subscription_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_subscription_filter(Result) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#get-tenant-ui-metadata + source: | + + # Get a tenant UI metadata + + try { + Get-BetaTenantUiMetadata + + # Below is a request that includes all optional parameters + # Get-BetaTenantUiMetadata + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/ui-metadata#get-tenant-ui-metadata + source: | + try: + # Get a tenant UI metadata + + api_response = api_instance.get_tenant_ui_metadata() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_ui_metadata() + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#set-tenant-ui-metadata + source: | + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/ui-metadata#set-tenant-ui-metadata + source: | + 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 + Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + api_response = api_instance.set_tenant_ui_metadata(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tenant_ui_metadata(Result) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "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" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-BetaVendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-BetaVendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "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" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-BetaVendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-BetaVendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Approve an Approval Item + + try { + Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-BetaApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-BetaWorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-BetaWorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item + source: | + $Id = "MyId" # String | ID of the work item. + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Get a Work Item + + try { + Get-BetaWorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-work-item + source: | + id = 'id_example' # str | ID of the work item. # str | ID of the work item. + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id, owner_id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + try: + # Forward a Work Item + Result = work_item_forward.from_json(work_item_forward) + api_instance.forward_work_item(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.forward_work_item(id, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items + source: | + $OwnerId = "MyOwnerId" # 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) + $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) + + # Completed Work Items + + try { + Get-BetaCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-completed-work-items + source: | + owner_id = 'owner_id_example' # 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-BetaCountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-count-completed-work-items + source: | + 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 + + api_response = api_instance.get_count_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-BetaCountWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-count-work-items + source: | + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-BetaWorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-BetaWorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-work-items-summary + source: | + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-BetaWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#list-work-items + 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) + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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. + + # Reject an Approval Item + + try { + Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-BetaApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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 + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-BetaAccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration + source: | + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#create-reassignment-configuration + source: | + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.create_reassignment_configuration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_reassignment_configuration(Result) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations + source: | + $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + + # List Reassignment Configurations + + try { + Get-BetaReassignmentConfigurations + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#list-reassignment-configurations + source: | + limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) + 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) + try: + # List Reassignment Configurations + + api_response = api_instance.list_reassignment_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_reassignment_configurations(limit, offset) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + + # Delete Reassignment Configuration + + try { + Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + try: + # Delete Reassignment Configuration + + api_instance.delete_reassignment_configuration(identity_id, config_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_reassignment_configuration(identity_id, config_type) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | 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) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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) + + 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 + + api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types + source: | + + # List Reassignment Config Types + + try { + Get-BetaReassignmentConfigTypes + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-config-types + source: | + try: + # List Reassignment Config Types + + api_response = api_instance.get_reassignment_config_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_config_types() + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + + # Get Reassignment Configuration + + try { + Get-BetaReassignmentConfiguration -IdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfiguration -IdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + try: + # Get Reassignment Configuration + + api_response = api_instance.get_reassignment_configuration(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_configuration(identity_id) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-reassignment-config + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.put_reassignment_config(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_reassignment_config(identity_id, Result) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-BetaTenantConfigConfiguration + + # Below is a request that includes all optional parameters + # Get-BetaTenantConfigConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + try: + # Get Tenant-wide Reassignment Configuration settings + + api_response = api_instance.get_tenant_config_configuration() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_config_configuration() + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration + source: | + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration -TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTenantConfiguration -TenantConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-tenant-configuration + source: | + tenant_configuration_request = { + "configDetails" : { + "disabled" : true + } + } # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + Result = tenant_configuration_request.from_json(tenant_configuration_request) + api_response = api_instance.put_tenant_configuration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tenant_configuration(Result) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "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" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow + source: | + 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" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.update_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workflow(id, Result) + print("The response of WorkflowsApi->update_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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-BetaWorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $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 = "status eq "Failed"" # 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + 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: **startTime**: *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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $Filters = "id eq "sp:create-campaign"" # 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* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/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) + $Filters = "id eq "idn:identity-attributes-changed"" # 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* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.post_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.post_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.post_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.beta.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {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}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml new file mode 100644 index 000000000..2d54f9602 --- /dev/null +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -0,0 +1,13367 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + try: + # Get Access Model Metadata Attribute + + api_response = api_instance.get_access_model_metadata_attribute(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute(key) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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. + try: + # Get Access Model Metadata Value + + api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + 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 + + api_response = api_instance.list_access_model_metadata_attribute() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute(filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + try: + # List Access Model Metadata Values + + api_response = api_instance.list_access_model_metadata_attribute_value(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute_value(key) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + 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/beta/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + 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/beta/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + 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/beta/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + 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/beta/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* 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* 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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + 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/beta/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-profiles#update-access-profiles-in-bulk + source: | + [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + + try: + # Update Access Profile(s) requestable field. + Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + api_response = api_instance.update_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-approvals#approve-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + try: + # Approve Access Request Approval + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.approve_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + 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/beta/methods/access-request-approvals#forward-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + forward_approval_dto = { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + 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/beta/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + 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/beta/methods/access-request-approvals#list-completed-approvals + source: | + owner_id = 'owner_id_example' # 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 = '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: **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 = '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: **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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + 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/beta/methods/access-request-approvals#list-pending-approvals + source: | + owner_id = 'owner_id_example' # 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 = '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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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* (optional) + 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: **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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + 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/beta/methods/access-request-approvals#reject-access-request + source: | + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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 + + api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +- path: /access-requests/close + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#close-access-request + source: | + close_access_request = { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } # CloseAccessRequest | + try: + # Close Access Request + Result = close_access_request.from_json(close_access_request) + api_response = api_instance.close_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.close_access_request(Result) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) +- path: /access-requests + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + 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/beta/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + 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/beta/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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/beta/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + 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/beta/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + 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/beta/methods/account-activities#list-account-activities + source: | + requested_for = 'requested_for_example' # 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 = 'requested_by_example' # 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 = 'regarding_identity_example' # 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) + type = 'type_example' # str | The type of account activity. (optional) # str | The type of account activity. (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 = '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: **type**: *eq, in, ge, gt, 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, gt, 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 = '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: **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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-aggregations#get-account-aggregation-status + source: | + id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id + try: + # In-progress Account Aggregation status + + api_response = api_instance.get_account_aggregation_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_aggregation_status(id) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + 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/beta/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#delete-account-async + source: | + id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id + try: + # Remove Account + + api_response = api_instance.delete_account_async(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account_async(id) + print("The response of AccountsApi->delete_account_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-account-for-identity + source: | + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + try: + # Disable IDN Account for Identity + + api_response = api_instance.disable_account_for_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account_for_identity(id) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#disable-accounts-for-identities + source: | + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + try: + # Disable IDN Accounts for Identities + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.disable_accounts_for_identities(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_accounts_for_identities(Result) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-account-for-identity + source: | + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + try: + # Enable IDN Account for Identity + + api_response = api_instance.enable_account_for_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account_for_identity(id) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#enable-accounts-for-identities + source: | + identities_accounts_bulk_request = { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } # IdentitiesAccountsBulkRequest | + try: + # Enable IDN Accounts for Identities + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.enable_accounts_for_identities(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_accounts_for_identities(Result) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + 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/beta/methods/accounts#get-account-entitlements + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + 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: + # Account Entitlements + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, offset, limit, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + 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/beta/methods/accounts#list-accounts + source: | + 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) + 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* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.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, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + try: + # Accounts List + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(detail_level, limit, offset, count, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + 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/beta/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + 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/beta/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + 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/beta/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + 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/beta/methods/accounts#update-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Account + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /discovered-applications/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-application-by-id + source: | + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + try: + # Get Discovered Application by ID + + api_instance.get_discovered_application_by_id(id) + + # Below is a request that includes all optional parameters + # api_instance.get_discovered_application_by_id(id) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-applications + 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) + 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: + # Retrieve discovered applications for tenant + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + 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/beta/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) +- path: /discovered-applications/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#patch-discovered-application-by-id + source: | + id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. + [{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional) + json_patch_operations = { + "op" : "replace", + "path" : "/dismissed", + "value" : true + } # List[JsonPatchOperations] | (optional) + + try: + # Patch Discovered Application by ID + + api_instance.patch_discovered_application_by_id(id, ) + + # Below is a request that includes all optional parameters + # api_instance.patch_discovered_application_by_id(id, Result) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/approvals#get-approval + source: | + id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned. + try: + # Get Approval + + api_response = api_instance.get_approval(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approval(id) + print("The response of ApprovalsApi->get_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) +- path: /generic-approvals + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/approvals#get-approvals + source: | + 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 + + api_response = api_instance.get_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approvals(mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) +- path: /source-apps + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#create-source-app + source: | + 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 + Result = source_app_create_dto.from_json(source_app_create_dto) + api_response = api_instance.create_source_app(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_app(Result) + print("The response of AppsApi->create_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # 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 + Result = request_body.from_json(request_body) + api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#delete-source-app + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. + try: + # Delete source app by ID + + api_response = api_instance.delete_source_app(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source_app(id) + print("The response of AppsApi->delete_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#get-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + try: + # Get source app by ID + + api_response = api_instance.get_source_app(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_app(id) + print("The response of AppsApi->get_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-access-profiles-for-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + 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 + + api_response = api_instance.list_access_profiles_for_source_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles_for_source_app(id, limit, offset, filters) + print("The response of AppsApi->list_access_profiles_for_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) +- path: /source-apps/all + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-all-source-app + 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) + 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 + + api_response = api_instance.list_all_source_app() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) +- path: /user-apps/all + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-all-user-apps + source: | + 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* + 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 + + api_response = api_instance.list_all_user_apps(filters, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_user_apps(filters, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-assigned-source-app + 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) + 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 + + api_response = api_instance.list_assigned_source_app() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_assigned_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-available-accounts-for-user-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app + 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 available accounts for user app + + api_response = api_instance.list_available_accounts_for_user_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_accounts_for_user_app(id, limit, count, offset) + print("The response of AppsApi->list_available_accounts_for_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) +- path: /source-apps + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-available-source-apps + 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) + 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 + + api_response = api_instance.list_available_source_apps() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_source_apps(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) +- path: /user-apps + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#list-owned-user-apps + 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) + 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 + + api_response = api_instance.list_owned_user_apps() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_owned_user_apps(limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#patch-source-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch source app by ID + + api_response = api_instance.patch_source_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_source_app(id, Result) + print("The response of AppsApi->patch_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#patch-user-app + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch user app by ID + + api_response = api_instance.patch_user_app(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_user_app(id, Result) + print("The response of AppsApi->patch_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/apps#update-source-apps-in-bulk + source: | + 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 + + api_instance.update_source_apps_in_bulk() + + # Below is a request that includes all optional parameters + # api_instance.update_source_apps_in_bulk(Result) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get. + try: + # Get Auth Profile. + + api_response = api_instance.get_profile_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config(id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) +- path: /auth-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config-list + source: | + try: + # Get list of Auth Profiles. + + api_response = api_instance.get_profile_config_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config_list() + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/auth-profile#patch-profile-config + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Auth Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_profile_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_profile_config(id, Result) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certification-campaigns#complete-campaign + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. + complete_campaign_options = { + "autoCompleteAction" : "REVOKE" + } # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#create-campaign + source: | + 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 Campaign + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#create-campaign-template + source: | + 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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/certification-campaigns#delete-campaigns + source: | + delete_campaigns_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # DeleteCampaignsRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = delete_campaigns_request.from_json(delete_campaigns_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. + try: + # Get Campaign + + api_response = api_instance.get_campaign(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + 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/beta/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#start-campaign-report + source: | + 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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of report to run. + try: + # Run Campaign Report + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + 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/beta/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign being modified. # str | ID of the campaign being modified. + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-item-permissions + source: | + 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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +- path: /certifications/{id}/tasks-pending + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-pending-tasks + source: | + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Pending Certification Tasks + + api_response = api_instance.get_identity_certification_pending_tasks(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_pending_tasks(id) + print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) +- path: /certifications/{id}/tasks/{taskId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-task-status + source: | + id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID + task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID + try: + # Certification Task Status + + api_response = api_instance.get_identity_certification_task_status(id, task_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_task_status(id, task_id) + print("The response of CertificationsApi->get_identity_certification_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) +- path: /certifications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#list-certifications + source: | + reviewer_identitiy = 'reviewer_identitiy_example' # 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 = '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: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + 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: **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: + # Certifications by IDs + + api_response = api_instance.list_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /connector-rules + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#create-connector-rule + source: | + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | The connector rule to create + try: + # Create Connector Rule + Result = connector_rule_create_request.from_json(connector_rule_create_request) + api_response = api_instance.create_connector_rule(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_connector_rule(Result) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#delete-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete # str | ID of the connector rule to delete + try: + # Delete a Connector-Rule + + api_instance.delete_connector_rule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_connector_rule(id) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve + try: + # Connector-Rule by ID + + api_response = api_instance.get_connector_rule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule(id) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) +- path: /connector-rules + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule-list + source: | + try: + # List Connector Rules + + api_response = api_instance.get_connector_rule_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule_list() + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#update-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + try: + # Update a Connector Rule + + api_response = api_instance.update_connector_rule(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector_rule(id, Result) + print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connector-rule-management#validate-connector-rule + source: | + source_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | The code to validate + try: + # Validate Connector Rule + Result = source_code.from_json(source_code) + api_response = api_instance.validate_connector_rule(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.validate_connector_rule(Result) + print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) +- path: /connectors + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/connectors#get-connector-list + source: | + 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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +- path: /form-definitions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition + source: | + create_form_definition_request = { + "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. + + api_response = api_instance.create_form_definition() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition(Result) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) +- path: /form-definitions/template + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-by-template + source: | + create_form_definition_request = { + "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: + # Create a form definition by template. + + api_response = api_instance.create_form_definition_by_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_by_template(Result) + print("The response of CustomFormsApi->create_form_definition_by_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-dynamic-schema + source: | + 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. + + api_response = api_instance.create_form_definition_dynamic_schema() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_dynamic_schema(Result) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-file-request + source: | + 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. + + api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) +- path: /form-instances + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-instance + source: | + 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. + + api_response = api_instance.create_form_instance() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_instance(Result) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#delete-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Deletes a form definition. + + api_response = api_instance.delete_form_definition(form_definition_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_form_definition(form_definition_id) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#export-form-definitions-by-tenant + source: | + 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. + + api_response = api_instance.export_form_definitions_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-file-from-s3 + source: | + 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. + + api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-definition-by-key + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Return a form definition. + + api_response = api_instance.get_form_definition_by_key(form_definition_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_definition_by_key(form_definition_id) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-by-key + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID + try: + # Returns a form instance. + + api_response = api_instance.get_form_instance_by_key(form_instance_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_by_key(form_instance_id) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-file + source: | + 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. + + api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#import-form-definitions + source: | + [{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) + 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. + + api_response = api_instance.import_form_definitions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_form_definitions(Result) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-definition + source: | + 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) + 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. + + api_response = api_instance.patch_form_definition(form_definition_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_definition(form_definition_id, Result) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-instance + source: | + 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) + 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. + + api_response = api_instance.patch_form_instance(form_instance_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_instance(form_instance_id, Result) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) +- path: /form-definitions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-definitions-by-tenant + source: | + 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. + + api_response = api_instance.search_form_definitions_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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. + + api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) +- path: /form-instances + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-instances-by-tenant + source: | + try: + # List form instances by tenant. + + api_response = api_instance.search_form_instances_by_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_instances_by_tenant() + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#search-pre-defined-select-options + source: | + try: + # List predefined select options. + + api_response = api_instance.search_pre_defined_select_options() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_pre_defined_select_options() + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-forms#show-preview-data-source + source: | + 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. + + api_response = api_instance.show_preview_data_source(form_definition_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_preview_data_source(form_definition_id, limit, filters, query, Result) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#create-custom-password-instructions + source: | + 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 + Result = custom_password_instruction.from_json(custom_password_instruction) + api_response = api_instance.create_custom_password_instructions(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_password_instructions(Result) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#delete-custom-password-instructions + source: | + page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. + 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 + + api_instance.delete_custom_password_instructions(page_id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_custom_password_instructions(page_id, locale) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#get-custom-password-instructions + source: | + page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. + 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 + + api_response = api_instance.get_custom_password_instructions(page_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_password_instructions(page_id, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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. + try: + # Add metadata to an entitlement. + + api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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. + try: + # Remove metadata from an entitlement. + + api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + except Exception as e: + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement + source: | + id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID + try: + # Get an entitlement + + api_response = api_instance.get_entitlement(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement(id) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement-request-config + source: | + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id + try: + # Get Entitlement Request Config + + api_response = api_instance.get_entitlement_request_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_request_config(id) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#import-entitlements-by-source + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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 + + api_response = api_instance.import_entitlements_by_source(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_by_source(id, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-children + source: | + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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 = '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 + + api_response = api_instance.list_entitlement_children(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_children(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-parents + source: | + id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement 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 = '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 + + api_response = api_instance.list_entitlement_parents(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_parents(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) +- path: /entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlements + source: | + 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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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. + + api_response = api_instance.list_entitlements() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#patch-entitlement + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch an entitlement + + api_response = api_instance.patch_entitlement(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_entitlement(id, Result) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#put-entitlement-request-config + source: | + id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID + 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 + } + } # EntitlementRequestConfig | + try: + # Replace Entitlement Request Config + Result = entitlement_request_config.from_json(entitlement_request_config) + api_response = api_instance.put_entitlement_request_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_entitlement_request_config(id, Result) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) +- path: /entitlements/reset/sources/{sourceId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#reset-source-entitlements + source: | + source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset + try: + # Reset Source Entitlements + + api_response = api_instance.reset_source_entitlements(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reset_source_entitlements(source_id) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/entitlements#update-entitlements-in-bulk + source: | + 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 + Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + api_instance.update_entitlements_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.update_entitlements_in_bulk(Result) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) +- path: /workgroups + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#create-workgroup + source: | + 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. + Result = workgroup_dto.from_json(workgroup_dto) + api_response = api_instance.create_workgroup(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workgroup(Result) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + try: + # Delete a Governance Group + + api_instance.delete_workgroup(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workgroup(id) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + + try: + # Remove members from Governance Group + Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroups-in-bulk + source: | + workgroup_bulk_delete_request = { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } # WorkgroupBulkDeleteRequest | + try: + # Delete Governance Group(s) + Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + api_response = api_instance.delete_workgroups_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroups_in_bulk(Result) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#get-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + try: + # Get Governance Group by Id + + api_response = api_instance.get_workgroup(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workgroup(id) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-connections + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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 + + api_response = api_instance.list_connections(workgroup_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_connections(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + 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 + + api_response = api_instance.list_workgroup_members(workgroup_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroup_members(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) +- path: /workgroups + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroups + source: | + 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 + + api_response = api_instance.list_workgroups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#patch-workgroup + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch a Governance Group + + api_response = api_instance.patch_workgroup(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workgroup(id, Result) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/governance-groups#update-workgroup-members + source: | + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + + try: + # Add members to Governance Group + Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + api_response = api_instance.update_workgroup_members(workgroup_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workgroup_members(workgroup_id, Result) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + 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: + # Notification of Ignored Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_ignored_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_ignored_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + 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: + # Notification of Requested Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_requested_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_requested_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + 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: + # Notification of Viewed Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_item(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_item(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + try: + # Notification of Viewed Access Request Recommendations in Bulk + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_items(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_items(Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + 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 = '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: **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 + + api_response = api_instance.get_access_request_recommendations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + 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) + 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 of Ignored Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_ignored_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + 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) + 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 = '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: **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 of Requested Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_requested_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + 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) + 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 = '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: **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 of Viewed Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_viewed_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) +- path: /common-access + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#create-common-access + source: | + 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 + Result = common_access_item_request.from_json(common_access_item_request) + api_response = api_instance.create_common_access(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_common_access(Result) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) +- path: /common-access + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#get-common-access + source: | + 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 + + api_response = api_instance.get_common_access() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_common_access(offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-common-access#update-common-access-status-in-bulk + source: | + [sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + try: + # Bulk update common access status + Result = common_access_id_status.from_json(common_access_id_status) + api_response = api_instance.update_common_access_status_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_common_access_status_in_bulk(Result) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) +- path: /translation-catalogs/{catalog-id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-message-catalogs#get-message-catalogs + source: | + catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog. + try: + # Get Message catalogs + + api_response = api_instance.get_message_catalogs(catalog_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_message_catalogs(catalog_id) + print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) +- path: /outliers/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#export-outliers-zip + source: | + 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 + + api_response = api_instance.export_outliers_zip() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_outliers_zip(type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outlier-snapshots + 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) + 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 + + api_response = api_instance.get_identity_outlier_snapshots() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outlier_snapshots(limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) +- path: /outliers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outliers + 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) + 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 + + api_response = api_instance.get_identity_outliers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outliers(limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + 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 + + api_response = api_instance.get_latest_identity_outlier_snapshots() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_latest_identity_outlier_snapshots(type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id + try: + # Get identity outlier contibuting feature summary + + api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier 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) + 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 + + api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#ignore-identity-outliers + source: | + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Ignore + Result = request_body.from_json(request_body) + api_instance.ignore_identity_outliers(Result) + + # Below is a request that includes all optional parameters + # api_instance.ignore_identity_outliers(Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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 + 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 + + api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-outliers#un-ignore-identity-outliers + source: | + request_body = ['request_body_example'] # List[str] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Unignore + Result = request_body.from_json(request_body) + api_instance.un_ignore_identity_outliers(Result) + + # Below is a request that includes all optional parameters + # api_instance.un_ignore_identity_outliers(Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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. + 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 + + api_response = api_instance.get_peer_group_outliers(strategy, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers(strategy, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) +- path: /recommendations/request + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations + source: | + 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 a Recommendation Based on Object + Result = recommendation_request_dto.from_json(recommendation_request_dto) + api_response = api_instance.get_recommendations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations(Result) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) +- path: /recommendations/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations-config + source: | + try: + # Get certification recommendation config values + + api_response = api_instance.get_recommendations_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations_config() + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-recommendations#update-recommendations-config + source: | + recommendation_config_dto = { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } # RecommendationConfigDto | + try: + # Update certification recommendation config values + Result = recommendation_config_dto.from_json(recommendation_config_dto) + api_response = api_instance.update_recommendations_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_recommendations_config(Result) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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 + 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. + + api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, Result) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-role-mining-sessions + source: | + 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 + Result = role_mining_session_dto.from_json(role_mining_session_dto) + api_response = api_instance.create_role_mining_sessions(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_mining_sessions(Result) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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 + try: + # Export (download) details for a potential role in a role mining session + + api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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 + try: + # Export (download) details for a potential role in a role mining session + + api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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 + 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 + + api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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 + try: + # Retrieve status of a potential role export job + + api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-all-potential-role-summaries + source: | + 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 + + api_response = api_instance.get_all_potential_role_summaries() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_all_potential_role_summaries(sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) + print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-identities-potential-role + source: | + 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 + 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 + + api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role + source: | + 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 + try: + # Retrieve potential role in session + + api_response = api_instance.get_potential_role(session_id, potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-applications + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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 + 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 + + api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-summaries + source: | + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + 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: + # Retrieve session's potential role summaries + + api_response = api_instance.get_potential_role_summaries(session_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-potential-role + source: | + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id + try: + # Retrieves a specific potential role + + api_response = api_instance.get_role_mining_potential_role(potential_role_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_potential_role(potential_role_id) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session + source: | + 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. + try: + # Get a role mining session + + api_response = api_instance.get_role_mining_session(session_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session-status + source: | + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + try: + # Get role mining session status state + + api_response = api_instance.get_role_mining_session_status(session_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session_status(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-sessions + source: | + 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 + + api_response = api_instance.get_role_mining_sessions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_sessions(filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-saved-potential-roles + source: | + 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 + + api_response = api_instance.get_saved_potential_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_potential_roles(sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-potential-role + source: | + 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 + [{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] | + 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 in session + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-potential-role + source: | + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-session + source: | + 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 + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role_mining_session(session_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_session(session_id, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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 + 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 + Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/icons#delete-icon + source: | + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + try: + # Delete an icon + + api_instance.delete_icon(object_type, object_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_icon(object_type, object_id) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/icons#set-icon + source: | + object_type = 'application' # str | Object type # str | Object type + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + 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 + + api_response = api_instance.set_icon(object_type, object_id, image) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_icon(object_type, object_id, image) + print("The response of IconsApi->set_icon:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#delete-identity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Delete identity + + api_instance.delete_identity(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity(id) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) +- path: /identities/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-identity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Identity Details + + api_response = api_instance.get_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity(id) + print("The response of IdentitiesApi->get_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-identity-ownership-details + source: | + identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. + try: + # Get ownership details + + api_response = api_instance.get_identity_ownership_details(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_ownership_details(identity_id) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignment + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id + try: + # Role assignment details + + api_response = api_instance.get_role_assignment(identity_id, assignment_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignment(identity_id, assignment_id) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignments + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for + 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 + + api_response = api_instance.get_role_assignments(identity_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignments(identity_id, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) +- path: /identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#list-identities + source: | + 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 + + api_response = api_instance.list_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identities(filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) +- path: /identities/{identityId}/reset + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#reset-identity + source: | + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + try: + # Reset an identity + + api_instance.reset_identity(identity_id) + + # Below is a request that includes all optional parameters + # api_instance.reset_identity(identity_id) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#send-identity-verification-account-token + source: | + 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 + Result = send_account_verification_request.from_json(send_account_verification_request) + api_instance.send_identity_verification_account_token(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_identity_verification_account_token(id, Result) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) +- path: /identities/invite + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#start-identities-invite + source: | + invite_identities_request = { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } # InviteIdentitiesRequest | + try: + # Invite identities to register + Result = invite_identities_request.from_json(invite_identities_request) + api_response = api_instance.start_identities_invite(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identities_invite(Result) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) +- path: /identities/process + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#start-identity-processing + source: | + process_identities_request = { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } # ProcessIdentitiesRequest | + try: + # Process a list of identityIds + Result = process_identities_request.from_json(process_identities_request) + api_response = api_instance.start_identity_processing(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identity_processing(Result) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identities#synchronize-attributes-for-identity + source: | + identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id + try: + # Attribute synchronization for single identity. + + api_response = api_instance.synchronize_attributes_for_identity(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.synchronize_attributes_for_identity(identity_id) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) +- path: /identity-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#create-identity-attribute + source: | + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.create_identity_attribute(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_attribute(Result) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + try: + # Delete Identity Attribute + + api_instance.delete_identity_attribute(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attribute(name) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + identity_attribute_names = { + "ids" : [ "name", "displayName" ] + } # IdentityAttributeNames | + try: + # Bulk delete Identity Attributes + Result = identity_attribute_names.from_json(identity_attribute_names) + api_instance.delete_identity_attributes_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attributes_in_bulk(Result) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#get-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + try: + # Get Identity Attribute + + api_response = api_instance.get_identity_attribute(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_attribute(name) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) +- path: /identity-attributes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#list-identity-attributes + source: | + 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 + + api_response = api_instance.list_identity_attributes() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_attributes(include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-attributes#put-identity-attribute + source: | + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.put_identity_attribute(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_identity_attribute(name, Result) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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 + + api_response = api_instance.compare_identity_snapshots(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) +- path: /historical-identities/{id}/compare/{accessType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 + 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 + + api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + try: + # Get latest snapshot of identity + + api_response = api_instance.get_historical_identity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity(id) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity-events + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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) + + 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) + + 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 + + api_response = api_instance.get_historical_identity_events(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->get_historical_identity_events:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot + source: | + 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 + try: + # Gets an identity snapshot at a given date + + api_response = api_instance.get_identity_snapshot(id, var_date) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot(id, var_date) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot-summary + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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 + + api_response = api_instance.get_identity_snapshot_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) + print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-start-date + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + try: + # Gets the start date of the identity + + api_response = api_instance.get_identity_start_date(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_start_date(id) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) +- path: /historical-identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-historical-identities + source: | + 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 + + api_response = api_instance.list_historical_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) + print("The response of IdentityHistoryApi->list_historical_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-access-items + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + filters = 'source eq \"DataScienceDataset\"' # 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + query = 'Dr. Arden' # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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 + + api_response = api_instance.list_identity_access_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshot-access-items + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID. + var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date. + type = 'account' # str | Access item type. (optional) # str | Access item type. (optional) + try: + # Get Identity Access Items Snapshot + + api_response = api_instance.list_identity_snapshot_access_items(id, var_date, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshots + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + 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 + + api_response = api_instance.list_identity_snapshots(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshots(id, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) +- path: /identity-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#create-identity-profile + source: | + identity_profile = { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "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" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } # IdentityProfile | + try: + # Create Identity Profile + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#export-identity-profiles + 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) + filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID + try: + # Default identity attribute config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#list-identity-profiles + 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) + filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#show-generate-identity-preview + source: | + 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.show_generate_identity_preview(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_generate_identity_preview(Result) + print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + 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/beta/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +- path: /launchers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#create-launcher + source: | + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to create a Launcher + try: + # Create launcher + Result = launcher_request.from_json(launcher_request) + api_response = api_instance.create_launcher(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_launcher(Result) + print("The response of LaunchersApi->create_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) +- path: /launchers/{launcherID} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#delete-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted + try: + # Delete Launcher + + api_instance.delete_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_launcher(launcher_id) + except Exception as e: + print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) +- path: /launchers/{launcherID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#get-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved + try: + # Get Launcher by ID + + api_response = api_instance.get_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_launcher(launcher_id) + print("The response of LaunchersApi->get_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) +- path: /launchers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#get-launchers + source: | + filters = 'disabled 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: **description**: *sw* **disabled**: *eq* **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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional) + limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10) + try: + # List all Launchers for tenant + + api_response = api_instance.get_launchers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_launchers(filters, next, limit) + print("The response of LaunchersApi->get_launchers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) +- path: /launchers/{launcherID} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#put-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced + launcher_request = { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } # LauncherRequest | Payload to replace Launcher + try: + # Replace Launcher + Result = launcher_request.from_json(launcher_request) + api_response = api_instance.put_launcher(launcher_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_launcher(launcher_id, Result) + print("The response of LaunchersApi->put_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) +- path: /beta/launchers/{launcherID}/launch + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/launchers#start-launcher + source: | + launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched + try: + # Launch a Launcher + + api_response = api_instance.start_launcher(launcher_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_launcher(launcher_id) + print("The response of LaunchersApi->start_launcher:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status + source: | + id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get + type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + try: + # Specified Managed Client Status. + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status + source: | + id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update + managed_client_status = { + "body" : { + "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" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } # ManagedClientStatus | + try: + # Handle status request from client + Result = managed_client_status.from_json(managed_client_status) + api_response = api_instance.update_managed_client_status(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client_status(id, Result) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration + source: | + id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for + try: + # Get managed cluster's log configuration + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + 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/beta/methods/managed-clusters#get-managed-cluster + source: | + id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get + try: + # Get a specified ManagedCluster. + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + 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/beta/methods/managed-clusters#get-managed-clusters + source: | + 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: + # Retrieve all Managed Clusters. + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + 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/beta/methods/managed-clusters#put-client-log-configuration + source: | + id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for + client_log_configuration = { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/mfa-configuration#delete-mfa-config + source: | + 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 + + api_response = api_instance.delete_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + 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/beta/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + 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/beta/methods/mfa-controller#create-send-token + source: | + send_token_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } # SendTokenRequest | + try: + # Create and send user token + Result = send_token_request.from_json(send_token_request) + api_response = api_instance.create_send_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_send_token(Result) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(api_response) + 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/beta/methods/mfa-controller#ping-verification-status + source: | + 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 + Result = verification_poll_request.from_json(verification_poll_request) + api_response = api_instance.ping_verification_status(method, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_verification_status(method, Result) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(api_response) + 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/beta/methods/mfa-controller#send-duo-verify-request + source: | + duo_verification_request = { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + Result = duo_verification_request.from_json(duo_verification_request) + api_response = api_instance.send_duo_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_duo_verify_request(Result) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(api_response) + 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/beta/methods/mfa-controller#send-kba-answers + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Authenticate KBA provided MFA method + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.send_kba_answers(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_kba_answers(Result) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(api_response) + 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/beta/methods/mfa-controller#send-okta-verify-request + source: | + okta_verification_request = { + "userId" : "example@mail.com" + } # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + Result = okta_verification_request.from_json(okta_verification_request) + api_response = api_instance.send_okta_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_okta_verify_request(Result) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(api_response) + 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/beta/methods/mfa-controller#send-token-auth-request + source: | + token_auth_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + Result = token_auth_request.from_json(token_auth_request) + api_response = api_instance.send_token_auth_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_token_auth_request(Result) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /multihosts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-multi-host-integration + source: | + multi_host_integrations_create = { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + try: + # Create Multi-Host Integration + Result = multi_host_integrations_create.from_json(multi_host_integrations_create) + api_response = api_instance.create_multi_host_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_multi_host_integration(Result) + print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) +- path: /multihosts/{multihostId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + [sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + multi_host_integrations_create_sources = { + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + } # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + + try: + # Create Sources Within Multi-Host Integration + Result = multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) + api_instance.create_sources_within_multi_host(multihost_id, Result) + + # Below is a request that includes all optional parameters + # api_instance.create_sources_within_multi_host(multihost_id, Result) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) +- path: /multihosts/{multihostId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#delete-multi-host + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. + try: + # Delete Multi-Host Integration + + api_instance.delete_multi_host(multihost_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_multi_host(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-acct-aggregation-groups + source: | + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + try: + # Get Account Aggregation Groups Within Multi-Host Integration ID + + api_response = api_instance.get_acct_aggregation_groups(multihost_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_acct_aggregation_groups(multihost_id) + print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + try: + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) +- path: /multihosts/{multihostId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. + try: + # Get Multi-Host Integration By ID + + api_response = api_instance.get_multi_host_integrations(multihost_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_integrations(multihost_id) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) +- path: /multihosts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations-list + source: | + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *in* **forSubAdminId**: *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: **type**: *in* **forSubAdminId**: *in* (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) + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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) + try: + # List All Existing Multi-Host Integrations + + api_response = api_instance.get_multi_host_integrations_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + try: + # List Multi-Host Source Creation Errors + + api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) +- path: /multihosts/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multihost-integration-types + source: | + try: + # List Multi-Host Integration Types + + api_response = api_instance.get_multihost_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_multihost_integration_types() + print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) +- path: /multihosts/{multihostId}/sources + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-sources-within-multi-host + source: | + multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *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**: *in* (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) + try: + # List Sources Within Multi-Host Integration + + api_response = api_instance.get_sources_within_multi_host(multihost_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) + print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) +- path: /multihosts/{multihostId}/sources/testConnection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-connection-multi-host-sources + source: | + multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + try: + # Test Configuration For Multi-Host Integration + + api_instance.test_connection_multi_host_sources(multihost_id) + + # Below is a request that includes all optional parameters + # api_instance.test_connection_multi_host_sources(multihost_id) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-source-connection-multihost + source: | + multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration + source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration + try: + # Test Configuration For Multi-Host Integration's Single Source + + api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) +- path: /multihosts/{multihostId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/multi-host-integration#update-multi-host-sources + source: | + multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. + [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. + + try: + # Update Multi-Host Integration + Result = update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) + api_instance.update_multi_host_sources(multihost_id, Result) + + # Below is a request that includes all optional parameters + # api_instance.update_multi_host_sources(multihost_id, Result) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_approval_decision = { + "comment" : "comment" + } # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # 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 Non-Employee Source Schema Attribute + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk + source: | + delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) + api_instance.delete_non_employee_record_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_record_in_bulk(Result) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format + try: + # Delete Non-Employee Request + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + try: + # Delete Non-Employee Source's Schema Attribute + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Bulk upload status on source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id + try: + # Get Schema Attribute Non-Employee Source + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#list-non-employee-approval + source: | + requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # 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 + + api_response = api_instance.list_non_employee_approval() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) +- path: /non-employee-records + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + requested_for = 'me' # 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 = 'approvalStatus,firstName' # 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # 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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 Non-Employee Source's Schema Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = { + "comment" : "comment" + } # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + 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/beta/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + id = '2c91808b6ef1d43e016efba0ce470904' # 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +- path: /verified-domains + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-domain-dkim + source: | + domain_address = { + "domain" : "sailpoint.com" + } # DomainAddress | + try: + # Verify domain address via DKIM + Result = domain_address.from_json(domain_address) + api_response = api_instance.create_domain_dkim(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_domain_dkim(Result) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) +- path: /notification-templates + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-notification-template + source: | + 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 + Result = template_dto.from_json(template_dto) + api_response = api_instance.create_notification_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_notification_template(Result) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#create-verified-from-address + source: | + email_status_dto = { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } # EmailStatusDto | + try: + # Create Verified From Address + Result = email_status_dto.from_json(email_status_dto) + api_response = api_instance.create_verified_from_address(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_verified_from_address(Result) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#delete-notification-templates-in-bulk + source: | + [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) + api_instance.delete_notification_templates_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_notification_templates_in_bulk(Result) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#delete-verified-from-address + source: | + id = 'id_example' # str | # str | + try: + # Delete Verified From Address + + api_instance.delete_verified_from_address(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_verified_from_address(id) + except Exception as e: + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) +- path: /verified-domains + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-dkim-attributes + source: | + try: + # Get DKIM Attributes + + api_response = api_instance.get_dkim_attributes() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dkim_attributes() + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) +- path: /mail-from-attributes/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-mail-from-attributes + source: | + identity_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 + try: + # Get MAIL FROM Attributes + + api_response = api_instance.get_mail_from_attributes(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mail_from_attributes(identity_id) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-notification-template + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template + try: + # Get Notification Template By Id + + api_response = api_instance.get_notification_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notification_template(id) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) +- path: /notification-template-context + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#get-notifications-template-context + source: | + try: + # Get Notification Template Context + + api_response = api_instance.get_notifications_template_context() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notifications_template_context() + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-from-addresses + 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) + 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 + + api_response = api_instance.list_from_addresses() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-preferences + source: | + key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key. + try: + # List Notification Preferences for tenant. + + api_response = api_instance.list_notification_preferences(key) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_preferences(key) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-template-defaults + 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) + 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 + + api_response = api_instance.list_notification_template_defaults() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_template_defaults(limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) +- path: /notification-templates + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-templates + 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) + 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 + + api_response = api_instance.list_notification_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_templates(limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#put-mail-from-attributes + source: | + mail_from_attributes_dto = { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } # MailFromAttributesDto | + try: + # Change MAIL FROM domain + Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) + api_response = api_instance.put_mail_from_attributes(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_mail_from_attributes(Result) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) +- path: /send-test-notification + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/notifications#send-test-notification + source: | + send_test_notification_request_dto = { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } # SendTestNotificationRequestDto | + try: + # Send Test Notification + Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) + api_instance.send_test_notification(Result) + + # Below is a request that includes all optional parameters + # api_instance.send_test_notification(Result) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) +- path: /oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/o-auth-clients#create-oauth-client + source: | + 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", "http://localhost:67890" ], + "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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + 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/beta/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + 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/beta/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + 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/beta/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +- path: /org-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#get-org-config + source: | + try: + # Get Org configuration settings + + api_response = api_instance.get_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_org_config() + print("The response of OrgConfigApi->get_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#get-valid-time-zones + source: | + try: + # Get list of time zones + + api_response = api_instance.get_valid_time_zones() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_valid_time_zones() + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) +- path: /org-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/org-config#patch-org-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Patch an Org configuration property + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_org_config(Result) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) +- path: /password-org-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + 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/beta/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + 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/beta/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + 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/beta/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + 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/beta/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#create-digit-token + source: | + password_digit_token_reset = { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } # PasswordDigitTokenReset | + try: + # Generate a digit token + Result = password_digit_token_reset.from_json(password_digit_token_reset) + api_response = api_instance.create_digit_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_digit_token(Result) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#get-identity-password-change-status + source: | + id = 'id_example' # str | # str | + try: + # Get Password Change Request Status + + api_response = api_instance.get_identity_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_password_change_status(id) + print("The response of PasswordManagementApi->get_identity_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) +- path: /query-password-info + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + 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/beta/methods/password-management#set-identity-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_identity_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_identity_password(Result) + print("The response of PasswordManagementApi->set_identity_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) +- path: /password-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + 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/beta/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + 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/beta/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + 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/beta/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + 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/beta/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + 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/beta/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + 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/beta/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + 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/beta/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + 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/beta/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + 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/beta/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + 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/beta/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +- path: /public-identities-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get Public Identity Config + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + 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/beta/methods/public-identities-config#update-public-identity-config + source: | + 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 Public Identity Config + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +- path: /requestable-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/requestable-objects#list-requestable-objects + source: | + 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.beta.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. Support for additional types may be added in the future without notice. (optional) + + types = [sailpoint.beta.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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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 = [sailpoint.beta.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#create-role-insight-requests + source: | + try: + # Generate insights for roles + + api_response = api_instance.create_role_insight_requests() + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_insight_requests() + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#download-role-insights-entitlements-changes + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.download_role_insights_entitlements_changes(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-entitlement-changes-identities + source: | + 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 + 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) + + api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insight + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + try: + # Get a single role insight + + api_response = api_instance.get_role_insight(insight_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insight(insight_id) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) +- path: /role-insights + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights + source: | + 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 + + api_response = api_instance.get_role_insights() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights(offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-current-entitlements + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.get_role_insights_current_entitlements(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_current_entitlements(insight_id, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-entitlements-changes + source: | + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + 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 + + api_response = api_instance.get_role_insights_entitlements_changes(insight_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-requests + source: | + id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id + try: + # Returns metadata from prior request. + + api_response = api_instance.get_role_insights_requests(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_requests(id) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-summary + source: | + try: + # Get role insights summary information + + api_response = api_instance.get_role_insights_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_summary() + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) +- path: /roles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + 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/beta/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + 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/beta/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + 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/beta/methods/roles#get-role-assigned-identities + source: | + 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: + # Identities assigned a Role + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#get-role-entitlements + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role + 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* (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 + + api_response = api_instance.get_role_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_entitlements(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) +- path: /roles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + 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/beta/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + search_attribute_config = { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } # SearchAttributeConfig | + try: + # Create Extended Search Attributes + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + 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/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + try: + # List Extended Search Attributes + + api_response = api_instance.get_search_attribute_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + 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/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + try: + # Get Extended Search Attribute + + api_response = api_instance.get_single_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + 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/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + 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/beta/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + 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/beta/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + 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/beta/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + 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/beta/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + 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/beta/methods/service-desk-integration#create-service-desk-integration + source: | + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + 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) + 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integration_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_list(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.beta.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + service_desk_integration_dto = { + "ownerRef" : "", + "cluster" : "xyzzy999", + "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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#create-sim-integration + source: | + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.create_sim_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sim_integration(Result) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#delete-sim-integration + source: | + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + try: + # Delete a SIM integration + + api_instance.delete_sim_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_sim_integration(id) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integration + source: | + id = '12345' # str | The id of the integration. # str | The id of the integration. + try: + # Get a SIM integration details. + + api_response = api_instance.get_sim_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integration(id) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integrations + source: | + try: + # List the existing SIM integrations. + + api_response = api_instance.get_sim_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integrations() + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-before-provisioning-rule + source: | + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_before_provisioning_rule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_before_provisioning_rule(id, Result) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-sim-attributes + source: | + id = '12345' # str | SIM integration id # str | SIM integration id + json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_sim_attributes(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sim_attributes(id, Result) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sim-integrations#put-sim-integration + source: | + id = '12345' # str | The id of the integration. # str | The id of the integration. + 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" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.put_sim_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sim_integration(id, Result) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + 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/beta/methods/sod-policies#delete-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) + try: + # Delete SOD policy by ID + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/sod-policies#delete-sod-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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/beta/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + 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/beta/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + 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/beta/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + 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/beta/methods/sod-policies#get-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD policy by ID + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + 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/beta/methods/sod-policies#get-sod-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD policy schedule + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + 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/beta/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + 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/beta/methods/sod-policies#get-sod-violation-report-status + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get SOD violation report status + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + 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/beta/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + 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/beta/methods/sod-policies#patch-sod-policy + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + request_body = [{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[object] | 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 + request_body = [{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[object] | 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 a SOD policy + Result = request_body.from_json(request_body) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + 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/beta/methods/sod-policies#put-policy-schedule + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } # SodPolicySchedule | + try: + # Update SOD Policy schedule + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + 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/beta/methods/sod-policies#put-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-all-policies-for-org + source: | + multi_policy_request = { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + 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/beta/methods/sod-policies#start-sod-policy + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + 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/beta/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +- path: /sources + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.beta.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete(id) + print("The response of SourcesApi->delete:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete: %s\n" % e) +- path: /sources/{sourceId}/remove-accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-accounts-async + source: | + source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id + try: + # Remove All Accounts in a Source + + api_response = api_instance.delete_accounts_async(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_accounts_async(source_id) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Delete Native Change Detection Configuration + + api_instance.delete_native_change_detection_config(source_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_native_change_detection_config(source_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) +- path: /sources/{sourceId}/correlation-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-correlation-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + api_response = api_instance.get_correlation_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_correlation_config(source_id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Native Change Detection Configuration + + api_response = api_instance.get_native_change_detection_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_native_change_detection_config(source_id) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +- path: /sources/{sourceId}/schemas/accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-accounts-schema + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_source_accounts_schema(source_id) + + # Below is a request that includes all optional parameters + # api_instance.get_source_accounts_schema(source_id) + except Exception as e: + print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-attr-sync-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Attribute Sync Config + + api_response = api_instance.get_source_attr_sync_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_attr_sync_config(id) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-config + source: | + id = 'id_example' # str | The Source id # str | The Source id + locale = 'locale_example' # 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 + + api_response = api_instance.get_source_config(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_config(id, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) +- path: /sources/{sourceId}/entitlement-request-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlement-request-config + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Get Source Entitlement Request Configuration + + api_response = api_instance.get_source_entitlement_request_config(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_entitlement_request_config(source_id) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/schemas/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlements-schema + source: | + source_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 + + api_instance.get_source_entitlements_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_source_entitlements_schema(source_id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +- path: /sources/{sourceId}/load-accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-accounts + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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 + + api_response = api_instance.import_accounts(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts(source_id, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) +- path: /sources/{sourceId}/load-entitlements + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-entitlements + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + 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: + # Entitlement Aggregation + + api_response = api_instance.import_entitlements(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements(source_id, file) + print("The response of SourcesApi->import_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) +- path: /sources/{sourceId}/schemas/accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-accounts-schema + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_source_accounts_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_accounts_schema(source_id, file) + print("The response of SourcesApi->import_source_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-connector-file + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_source_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_connector_file(source_id, file) + print("The response of SourcesApi->import_source_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) +- path: /sources/{sourceId}/schemas/entitlements + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-source-entitlements-schema + source: | + source_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 + + api_response = api_instance.import_source_entitlements_schema(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_source_entitlements_schema(source_id, schema_name, file) + print("The response of SourcesApi->import_source_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#import-uncorrelated-accounts + source: | + source_id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Process Uncorrelated Accounts + + api_response = api_instance.import_uncorrelated_accounts(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_uncorrelated_accounts(source_id, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +- path: /sources + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#list-sources + 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) + 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* **modified**: *eq* **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* **modified**: *eq* **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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#peek-resource-objects + source: | + 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 + Result = resource_objects_request.from_json(resource_objects_request) + api_response = api_instance.peek_resource_objects(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.peek_resource_objects(source_id, Result) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#ping-cluster + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Ping cluster for source connector + + api_response = api_instance.ping_cluster(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_cluster(source_id) + print("The response of SourcesApi->ping_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) +- path: /sources/{sourceId}/correlation-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-correlation-config + source: | + source_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 + Result = correlation_config.from_json(correlation_config) + api_response = api_instance.put_correlation_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_correlation_config(source_id, Result) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-native-change-detection-config + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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 + Result = native_change_detection_config.from_json(native_change_detection_config) + api_response = api_instance.put_native_change_detection_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_native_change_detection_config(source_id, Result) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.beta.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source-attr-sync-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + 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 + Result = attr_sync_source_config.from_json(attr_sync_source_config) + api_response = api_instance.put_source_attr_sync_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_attr_sync_config(id, Result) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#put-source-schema + source: | + 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.beta.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +- path: /sources/{sourceId}/synchronize-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#sync-attributes-for-source + source: | + source_id = 'source_id_example' # str | The Source id # str | The Source id + try: + # Synchronize single source attributes. + + api_response = api_instance.sync_attributes_for_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_attributes_for_source(source_id) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#test-source-configuration + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Test configuration for source connector + + api_response = api_instance.test_source_configuration(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_configuration(source_id) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#test-source-connection + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + try: + # Check connection for source connector. + + api_response = api_instance.test_source_connection(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection(source_id) + print("The response of SourcesApi->test_source_connection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.beta.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +- path: /sources/{sourceId}/entitlement-request-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source-entitlement-request-config + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + 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 + Result = source_entitlement_request_config.from_json(source_entitlement_request_config) + api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{op=replace, path=/displayAttribute, value={new-display-attribute=null}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config + source: | + export_payload = { + "description" : "Export Job 1 Test" + } # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + Result = export_payload.from_json(export_payload) + api_response = api_instance.export_sp_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_sp_config(Result) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export + source: | + 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. + + api_response = api_instance.get_sp_config_export(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status + source: | + 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 + + api_response = api_instance.get_sp_config_export_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import + source: | + 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 + + api_response = api_instance.get_sp_config_import(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status + source: | + 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 + + api_response = api_instance.get_sp_config_import_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config + source: | + 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.beta.ImportOptions() # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + api_response = api_instance.import_sp_config(data, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects + source: | + try: + # Get config object details + + api_response = api_instance.list_sp_config_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + api_response = api_instance.get_sed_batch_stats(batch_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batches + source: | + try: + # List Sed Batch Request + + api_response = api_instance.get_sed_batches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#list-seds + source: | + limit = limit=25 # int | 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) # int | 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) + 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 = count=true # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + count_only = count-only=true # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + requested_by_anyone = requested-by-anyone=true # 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) # 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) + show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) + try: + # List Suggested Entitlement Descriptions + + api_response = api_instance.list_seds() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#patch-sed + source: | + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + [sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + try: + # Patch Suggested Entitlement Description + Result = sed_patch.from_json(sed_patch) + api_response = api_instance.patch_sed(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sed(id, Result) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-approval + source: | + [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + try: + # Submit Bulk Approval Request + Result = sed_approval.from_json(sed_approval) + api_response = api_instance.submit_sed_approval(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_approval(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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 + Result = sed_assignment.from_json(sed_assignment) + api_response = api_instance.submit_sed_assignment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_assignment(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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 + + api_response = api_instance.submit_sed_batch_request() + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_batch_request(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tags-to-many-object + source: | + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Remove Tags from Multiple Objects + Result = bulk_tagged_object.from_json(bulk_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +- path: /tagged-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +- path: /tagged-objects + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tags-to-many-objects + source: | + bulk_tagged_object = { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + Result = bulk_tagged_object.from_json(bulk_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +- path: /tags + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#create-tag + source: | + tag = { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "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" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } # Tag | + try: + # Create Tag + Result = tag.from_json(tag) + api_response = api_instance.create_tag(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_tag(Result) + print("The response of TagsApi->create_tag:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->create_tag: %s\n" % e) +- path: /tags/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#delete-tag-by-id + source: | + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete. + try: + # Delete Tag + + api_instance.delete_tag_by_id(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tag_by_id(id) + except Exception as e: + print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) +- path: /tags/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#get-tag-by-id + source: | + id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get Tag By Id + + api_response = api_instance.get_tag_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tag_by_id(id) + print("The response of TagsApi->get_tag_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) +- path: /tags + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tags#list-tags + 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) + filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # 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,-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** (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** (optional) + try: + # List Tags + + api_response = api_instance.list_tags() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tags(limit, offset, count, filters, sorters) + print("The response of TagsApi->list_tags:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TagsApi->list_tags: %s\n" % e) +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-task-headers + source: | + 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 + + api_instance.get_pending_task_headers() + + # Below is a request that includes all optional parameters + # api_instance.get_pending_task_headers(offset, limit, count) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-tasks + source: | + 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 + + api_response = api_instance.get_pending_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_tasks(offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status + source: | + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + try: + # Get Task Status by ID + + api_response = api_instance.get_task_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status(id) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) +- path: /task-status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status-list + 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) + 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 + + api_response = api_instance.get_task_status_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status_list(limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/task-management#update-task-status + source: | + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + try: + # Update Task Status by ID + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_task_status(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_task_status(id, Result) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) +- path: /tenant + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/tenant#get-tenant + source: | + try: + # Get Tenant Information. + + api_response = api_instance.get_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) +- path: /transforms + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +- path: /transforms + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#complete-trigger-invocation + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. + complete_invocation = { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } # CompleteInvocation | + try: + # Complete Trigger Invocation + Result = complete_invocation.from_json(complete_invocation) + api_instance.complete_trigger_invocation(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.complete_trigger_invocation(id, Result) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#create-subscription + source: | + 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 + Result = subscription_post_request.from_json(subscription_post_request) + api_response = api_instance.create_subscription(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_subscription(Result) + print("The response of TriggersApi->create_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#delete-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + try: + # Delete a Subscription + + api_instance.delete_subscription(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_subscription(id) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-subscriptions + 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) + 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 + + api_response = api_instance.list_subscriptions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_subscriptions(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-trigger-invocation-status + 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) + 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 + + api_response = api_instance.list_trigger_invocation_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_trigger_invocation_status(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) +- path: /triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#list-triggers + 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) + 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 + + api_response = api_instance.list_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_triggers(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#patch-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch + [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + try: + # Patch a Subscription + Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) + api_response = api_instance.patch_subscription(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_subscription(id, Result) + print("The response of TriggersApi->patch_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#start-test-trigger-invocation + source: | + 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 + Result = test_invocation.from_json(test_invocation) + api_response = api_instance.start_test_trigger_invocation(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_test_trigger_invocation(Result) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#test-subscription-filter + source: | + validate_filter_input_dto = { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } # ValidateFilterInputDto | + try: + # Validate a Subscription Filter + Result = validate_filter_input_dto.from_json(validate_filter_input_dto) + api_response = api_instance.test_subscription_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_subscription_filter(Result) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/triggers#update-subscription + source: | + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + 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 + Result = subscription_put_request.from_json(subscription_put_request) + api_response = api_instance.update_subscription(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_subscription(id, Result) + print("The response of TriggersApi->update_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/ui-metadata#get-tenant-ui-metadata + source: | + try: + # Get a tenant UI metadata + + api_response = api_instance.get_tenant_ui_metadata() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_ui_metadata() + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/ui-metadata#set-tenant-ui-metadata + source: | + 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 + Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + api_response = api_instance.set_tenant_ui_metadata(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tenant_ui_metadata(Result) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions + source: | + 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: **startTime**: *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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.post_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.post_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->post_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.post_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.beta.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow + source: | + 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" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.update_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workflow(id, Result) + print("The response of WorkflowsApi->update_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + try: + # Forward a Work Item + Result = work_item_forward.from_json(work_item_forward) + api_instance.forward_work_item(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.forward_work_item(id, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-completed-work-items + source: | + owner_id = 'owner_id_example' # 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-count-completed-work-items + source: | + 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 + + api_response = api_instance.get_count_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-count-work-items + source: | + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-work-item + source: | + id = 'id_example' # str | ID of the work item. # str | ID of the work item. + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id, owner_id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#get-work-items-summary + source: | + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#list-work-items + 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) + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#create-reassignment-configuration + source: | + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.create_reassignment_configuration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_reassignment_configuration(Result) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + try: + # Delete Reassignment Configuration + + api_instance.delete_reassignment_configuration(identity_id, config_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_reassignment_configuration(identity_id, config_type) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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) + + 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 + + api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-config-types + source: | + try: + # List Reassignment Config Types + + api_response = api_instance.get_reassignment_config_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_config_types() + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + try: + # Get Reassignment Configuration + + api_response = api_instance.get_reassignment_configuration(identity_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_configuration(identity_id) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + try: + # Get Tenant-wide Reassignment Configuration settings + + api_response = api_instance.get_tenant_config_configuration() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_config_configuration() + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#list-reassignment-configurations + source: | + limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) + 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) + try: + # List Reassignment Configurations + + api_response = api_instance.list_reassignment_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_reassignment_configurations(limit, offset) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-reassignment-config + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.put_reassignment_config(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_reassignment_config(identity_id, Result) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-tenant-configuration + source: | + tenant_configuration_request = { + "configDetails" : { + "disabled" : true + } + } # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + Result = tenant_configuration_request.from_json(tenant_configuration_request) + api_response = api_instance.put_tenant_configuration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tenant_configuration(Result) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) diff --git a/static/code-examples/v2024/merged_code_examples.yaml b/static/code-examples/v2024/merged_code_examples.yaml new file mode 100644 index 000000000..9eb993f50 --- /dev/null +++ b/static/code-examples/v2024/merged_code_examples.yaml @@ -0,0 +1,31684 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Access Model Metadata Attribute + + try { + Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + 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 + + api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Value + + try { + Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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 + + api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # List Access Model Metadata Attributes + + try { + Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # List Access Model Metadata Values + + try { + Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + 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 + + api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "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 + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-V2024AccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $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) + + # List Access Profiles + + try { + Get-V2024AccessProfiles + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfiles -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-V2024AccessProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-V2024AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-V2024AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $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 = "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* 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, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-V2024AccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#update-access-profiles-in-bulk + source: | + x_sail_point_experimental = 'true' # 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=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + + try: + # Update Access Profile(s) requestable field. + Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-V2024AccessRequest -ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#approve-access-request + source: | + 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 + + api_response = api_instance.approve_access_request(approval_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#forward-access-request + source: | + 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 + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-V2024AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) +- path: /access-request-approvals/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-access-request-approvers + source: | + $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Count = $false # Boolean | 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) + + # Access Request Approvers + + try { + Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-access-request-approvers + source: | + access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID. + 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) + 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) + try: + # Access Request Approvers + + api_response = api_instance.list_access_request_approvers(access_request_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_request_approvers(access_request_id, limit, offset, count) + print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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 # 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 "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: **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" # 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) + + # Completed Access Request Approvals List + + try { + Get-V2024CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-V2024CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-completed-approvals + source: | + 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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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 # 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 "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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $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-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-V2024PendingApprovals + + # Below is a request that includes all optional parameters + # Get-V2024PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-pending-approvals + source: | + 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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#reject-access-request + source: | + 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 + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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 + + api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) +- path: /access-request-approvals/bulk-approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#approve-bulk-access-request + source: | + $BulkApproveAccessRequest = @" + { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } + "@ + + # Bulk Approve Access Request + + try { + $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest + Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result + + # Below is a request that includes all optional parameters + # Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#approve-bulk-access-request + source: | + bulk_approve_access_request = { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } # BulkApproveAccessRequest | + try: + # Bulk Approve Access Request + Result = bulk_approve_access_request.from_json(bulk_approve_access_request) + api_response = api_instance.approve_bulk_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_bulk_access_request(Result) + print("The response of AccessRequestsApi->approve_bulk_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-V2024AccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +- path: /access-requests/bulk-cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request-in-bulk + source: | + $BulkCancelAccessRequest = @" + { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } + "@ + + # Bulk Cancel Access Request + + try { + $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest + Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request-in-bulk + source: | + bulk_cancel_access_request = { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } # BulkCancelAccessRequest | + try: + # Bulk Cancel Access Request + Result = bulk_cancel_access_request.from_json(bulk_cancel_access_request) + api_response = api_instance.cancel_access_request_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request_in_bulk(Result) + print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#close-access-request + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#close-access-request + source: | + x_sail_point_experimental = 'true' # 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 + Result = close_access_request.from_json(close_access_request) + api_response = api_instance.close_access_request(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.close_access_request(x_sail_point_experimental, Result) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "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" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-V2024AccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-V2024AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "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 + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-V2024AccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | 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) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | 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 # Boolean | 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 = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | 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"" # 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: **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" # 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, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-V2024AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +- path: /access-request-administration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-administrators-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | 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) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | 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 # Boolean | 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 = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | 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"" # 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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, accountActivityItemId, name, accessRequestId** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status for Administrators + + try { + Get-V2024AdministratorsAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#list-administrators-access-request-status + source: | + 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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, accessRequestId** (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, accessRequestId** (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 for Administrators + + api_response = api_instance.list_administrators_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) + print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-V2024AccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-activities#list-account-activities + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | 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 # 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 = "type eq "Identity Refresh"" # 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: **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" # 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: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-V2024AccountActivities + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-activities#list-account-activities + source: | + 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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # In-progress Account Aggregation status + + try { + Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-aggregations#get-account-aggregation-status + source: | + 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 + + api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "-date" # 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: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-V2024Account -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-V2024Account -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#list-accounts + 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) + $DetailLevel = "SLIM" # String | 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"" # 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* **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" # 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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-V2024Accounts + + # Below is a request that includes all optional parameters + # Get-V2024Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#list-accounts + 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) + 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 + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-V2024Account -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-V2024Account -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-V2024Account -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-V2024Account -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Account -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Account -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#update-account + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Remove Account + + try { + Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account-async + source: | + 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 + + api_response = api_instance.delete_account_async(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account_async(id, x_sail_point_experimental) + print("The response of AccountsApi->delete_account_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-V2024Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Disable IDN Account for Identity + + try { + Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account-for-identity + source: | + 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 + + api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-accounts-for-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-accounts-for-identities + source: | + x_sail_point_experimental = 'true' # 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 + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-V2024Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Enable IDN Account for Identity + + try { + Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account-for-identity + source: | + 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 + + api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-accounts-for-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-accounts-for-identities + source: | + x_sail_point_experimental = 'true' # 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 + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account 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) + + # Account Entitlements + + try { + Get-V2024AccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#get-account-entitlements + source: | + 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 + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-V2024ReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-V2024ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Detail = "SLIM" # String | 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")" # 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, 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" # 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, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-V2024DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-V2024DiscoveredApplications -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-discovered-applications + 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) + 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 + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-V2024ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-V2024ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get an approval + + try { + Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/approvals#get-approval + source: | + 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 + + api_response = api_instance.get_approval(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approval(id, x_sail_point_experimental) + print("The response of ApprovalsApi->get_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) + $Filters = "filters=status 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: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/approvals#get-approvals + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_approvals(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approvals(x_sail_point_experimental, mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#create-source-app + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#create-source-app + source: | + x_sail_point_experimental = 'true' # 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 + Result = source_app_create_dto.from_json(source_app_create_dto) + api_response = api_instance.create_source_app(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_app(x_sail_point_experimental, Result) + print("The response of AppsApi->create_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $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) + $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: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-V2024AvailableSourceApps -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-available-source-apps + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_available_source_apps(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ + + $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) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024AccessProfilesFromSourceAppByBulk -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + 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] | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete source app by ID + + try { + Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#delete-source-app + source: | + 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 + + api_response = api_instance.delete_source_app(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->delete_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get source app by ID + + try { + Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#get-source-app + source: | + 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 + + api_response = api_instance.get_source_app(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->get_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#patch-source-app + source: | + 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') + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch source app by ID + + api_response = api_instance.patch_source_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_source_app(id, x_sail_point_experimental, Result) + print("The response of AppsApi->patch_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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) + $Filters = "name eq "developer access profile"" # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-V2024AccessProfilesForSourceApp -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-access-profiles-for-source-app + source: | + 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 + + api_response = api_instance.list_access_profiles_for_source_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $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) + $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: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled 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: **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) + + # List all source apps + + try { + Get-V2024AllSourceApp -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-all-source-app + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_all_source_app(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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) + $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 all user apps + + try { + Get-V2024AllUserApps -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-all-user-apps + source: | + 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 + + api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $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) + $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: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-V2024AssignedSourceApp -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-assigned-source-app + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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) + + # List available accounts for user app + + try { + Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-available-accounts-for-user-app + source: | + 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 + + api_response = api_instance.list_available_accounts_for_user_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $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) + $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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OwnedUserApps -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-owned-user-apps + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#patch-user-app + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch user app by ID + + api_response = api_instance.patch_user_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_user_app(id, x_sail_point_experimental, Result) + print("The response of AppsApi->patch_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/apps#update-source-apps-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#update-source-apps-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + + api_instance.update_source_apps_in_bulk(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.update_source_apps_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + try { + Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_profile_config(x_sail_point_experimental, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config(x_sail_point_experimental, id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#patch-profile-config + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Auth Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + try { + Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config-list + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_profile_config_list(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config_list(x_sail_point_experimental) + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-users#get-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-V2024AuthUser -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-users#get-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + api_response = api_instance.get_auth_user(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/auth-users#patch-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-users#patch-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_user(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_user(id, Result) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#create-branding-item + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-V2024BrandingItem -Name $Name -ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-V2024BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#create-branding-item + source: | + 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 + + api_response = api_instance.create_branding_item(name, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#get-branding-list + source: | + + # List of branding items + + try { + Get-V2024BrandingList + + # Below is a request that includes all optional parameters + # Get-V2024BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#get-branding-list + source: | + try: + # List of branding items + + api_response = api_instance.get_branding_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#delete-branding + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-V2024Branding -Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#delete-branding + source: | + 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 + + api_instance.delete_branding(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_branding(name) + except Exception as e: + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#get-branding + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-V2024Branding -Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#get-branding + source: | + 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 + + api_response = api_instance.get_branding(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/branding#set-branding-item + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#set-branding-item + source: | + 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 + + api_response = api_instance.set_branding_item(name, name2, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#create-campaign-filter + source: | + $CampaignFilterDetails = @" + { + "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 + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-V2024CampaignFilter -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignFilter -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#create-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.create_campaign_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_filter(Result) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#list-campaign-filters + 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) + $Start = 0 # Int32 | 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) + $IncludeSystemFilters = $true # Boolean | 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) + + # List Campaign Filters + + try { + Get-V2024CampaignFilters + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#list-campaign-filters + 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) + 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 + + api_response = api_instance.list_campaign_filters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#delete-campaign-filters + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024CampaignFilters -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignFilters -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#delete-campaign-filters + source: | + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + + try: + # Deletes Campaign Filters + Result = request_body.from_json(request_body) + api_instance.delete_campaign_filters(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_filters(Result) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-V2024CampaignFilterById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + 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 + + api_response = api_instance.get_campaign_filter_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#update-campaign-filter + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "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 + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#update-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.update_campaign_filter(filter_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign_filter(filter_id, Result) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-V2024Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024Campaign -Id $Id -CampaignCompleteOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#complete-campaign + source: | + 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 + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign + source: | + $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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-V2024Campaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-V2024Campaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign + source: | + 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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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 + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | 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 # 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 "Manager Campaign"" # 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* **status**: *eq, in* (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, created** (optional) + + # List Campaigns + + try { + Get-V2024ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-V2024ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-V2024CampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign-template + source: | + 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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-templates + 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 = "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, created, modified** (optional) + $Filters = "name eq "manager template"" # 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, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-V2024CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-V2024CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-V2024CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-V2024CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-V2024CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | 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" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-V2024CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-V2024CampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaigns + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-V2024Campaigns -CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024Campaigns -CampaignsDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaigns + source: | + campaigns_delete_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = campaigns_delete_request.from_json(campaigns_delete_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-V2024Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign + source: | + 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 + + api_response = api_instance.get_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Campaign -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Campaign -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-V2024CampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-V2024CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-V2024 -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-V2024 -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-V2024Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024Campaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-V2024CampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-V2024CampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-V2024CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-report + source: | + 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.v2024.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run. + try: + # Run Campaign Report + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-V2024GenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $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 "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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + 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 + + api_response = api_instance.get_identity_access_summaries(id, type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.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: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + 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 + + api_response = api_instance.get_identity_decision_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification 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) + $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, in* **completed**: *eq, ne* **name**: *eq, 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) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + 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 + + api_response = api_instance.get_identity_summaries(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + 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 + + api_response = api_instance.get_identity_summary(id, identity_summary_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-certification-task + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-V2024CertificationTask -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-certification-task + source: | + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + api_response = api_instance.get_certification_task(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-V2024IdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + api_response = api_instance.get_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # 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: **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 # 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) + + # Permissions for Entitlement Certification Item + + try { + Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification-item-permissions + source: | + 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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-pending-certification-tasks + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *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 = "type eq "ADMIN_REASSIGN"" # 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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-V2024PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-V2024PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-pending-certification-tasks + source: | + 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 + + api_response = api_instance.get_pending_certification_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification 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) + $Filters = "name eq "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, sw* **email**: *eq, 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, email** (optional) + + # List of Reviewers for certification + + try { + Get-V2024CertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-access-review-items + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification 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) + $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, 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" # 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | 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) + $AccessProfiles = "accessProfile1" # String | 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" # String | 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) + + # List of Access Review Items + + try { + Get-V2024IdentityAccessReviewItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-access-review-items + source: | + 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 + + api_response = api_instance.list_identity_access_review_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-certifications + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *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 = "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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # 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, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-V2024IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-certifications + source: | + 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 + + api_response = api_instance.list_identity_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#make-identity-decision + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#make-identity-decision + source: | + 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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + try: + # Decide on a Certification Item + Result = review_decision.from_json(review_decision) + api_response = api_instance.make_identity_decision(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.make_identity_decision(id, Result) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#reassign-identity-certifications + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#reassign-identity-certifications + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.reassign_identity_certifications(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reassign_identity_certifications(id, Result) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#sign-off-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-V2024SignOffIdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Invoke-V2024SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#sign-off-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + api_response = api_instance.sign_off_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /configuration-hub/deploys + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-deploy + source: | + $DeployRequest = @" + { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } + "@ + + # Create a Deploy + + try { + $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest + New-V2024Deploy -DeployRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Deploy -DeployRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-deploy + source: | + deploy_request = { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } # DeployRequest | The deploy request body. + try: + # Create a Deploy + Result = deploy_request.from_json(deploy_request) + api_response = api_instance.create_deploy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_deploy(Result) + print("The response of ConfigurationHubApi->create_deploy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) +- path: /configuration-hub/deploys + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-deploys + source: | + + # List Deploys + + try { + Get-V2024Deploys + + # Below is a request that includes all optional parameters + # Get-V2024Deploys + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-deploys + source: | + try: + # List Deploys + + api_response = api_instance.list_deploys() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_deploys() + print("The response of ConfigurationHubApi->list_deploys:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mapping + source: | + 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 + Result = object_mapping_request.from_json(object_mapping_request) + api_response = api_instance.create_object_mapping(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mapping(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-V2024ObjectMappings -SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-V2024ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-object-mappings + source: | + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + api_response = api_instance.get_object_mappings(source_org) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "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" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mappings + source: | + 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 + Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + api_response = api_instance.create_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-uploaded-configuration + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-V2024UploadedConfiguration -Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-V2024UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-uploaded-configuration + source: | + 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 + + api_response = api_instance.create_uploaded_configuration(data, name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-uploaded-configurations + source: | + $Filters = "status eq "COMPLETE"" # 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: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-V2024UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-uploaded-configurations + source: | + 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 + + api_response = api_instance.list_uploaded_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) +- path: /configuration-hub/backups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-backup + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. + + # Delete a Backup + + try { + Remove-V2024Backup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Backup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-backup + source: | + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete. + try: + # Delete a Backup + + api_instance.delete_backup(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_backup(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) +- path: /configuration-hub/drafts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-draft + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. + + # Delete a draft + + try { + Remove-V2024Draft -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Draft -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-draft + source: | + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete. + try: + # Delete a draft + + api_instance.delete_draft(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_draft(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-object-mapping + source: | + 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 + + api_instance.delete_object_mapping(source_org, object_mapping_id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-V2024UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-uploaded-configuration + source: | + 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 + + api_instance.delete_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_uploaded_configuration(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-V2024UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-uploaded-configuration + source: | + 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 + + api_response = api_instance.get_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/deploys/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#get-deploy + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. + + # Get a Deploy + + try { + Get-V2024Deploy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Deploy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-deploy + source: | + id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy. + try: + # Get a Deploy + + api_response = api_instance.get_deploy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_deploy(id) + print("The response of ConfigurationHubApi->get_deploy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) +- path: /configuration-hub/backups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-backups + source: | + $Filters = "status eq "COMPLETE"" # 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: **status**: *eq* (optional) + + # List Backups + + try { + Get-V2024Backups + + # Below is a request that includes all optional parameters + # Get-V2024Backups -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-backups + source: | + 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 Backups + + api_response = api_instance.list_backups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_backups(filters) + print("The response of ConfigurationHubApi->list_backups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) +- path: /configuration-hub/drafts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-drafts + source: | + $Filters = "status eq "COMPLETE"" # 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: **status**: *eq* **approvalStatus**: *eq* (optional) + + # List Drafts + + try { + Get-V2024Drafts + + # Below is a request that includes all optional parameters + # Get-V2024Drafts -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-drafts + source: | + 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* **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: **status**: *eq* **approvalStatus**: *eq* (optional) + try: + # List Drafts + + api_response = api_instance.list_drafts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_drafts(filters) + print("The response of ConfigurationHubApi->list_drafts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "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" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#update-object-mappings + source: | + 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 + Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + api_response = api_instance.update_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) +- path: /connector-rules + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#create-connector-rule + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | Connector rule to create. + try: + # Create Connector Rule + Result = connector_rule_create_request.from_json(connector_rule_create_request) + api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule-list + 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) + + # List Connector Rules + + 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule-list + source: | + x_sail_point_experimental = 'true' # 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: + # List Connector Rules + + api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, limit, offset, count) + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#delete-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule 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 Connector Rule + + api_instance.delete_connector_rule(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_connector_rule(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule 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 Connector Rule + + api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#put-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + try: + # Update Connector Rule + + api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) +- path: /connector-rules/validate + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#test-connector-rule + source: | + x_sail_point_experimental = 'true' # 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_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | Code to validate. + try: + # Validate Connector Rule + Result = source_code.from_json(source_code) + api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024CustomConnector -V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomConnector -V3CreateConnectorDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#create-custom-connector + source: | + v3_create_connector_dto = { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } # V3CreateConnectorDto | + try: + # Create Custom Connector + Result = v3_create_connector_dto.from_json(v3_create_connector_dto) + api_response = api_instance.create_custom_connector(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_connector(Result) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorList + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-list + source: | + 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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024CustomConnector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-V2024CustomConnector -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#delete-custom-connector + source: | + 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 + + api_instance.delete_custom_connector(script_name) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Connector -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024Connector -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector + source: | + 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 + + api_response = api_instance.get_connector(script_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#update-connector + source: | + 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. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + try: + # Update Connector by Script Name + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_connector(script_name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector(script_name, Result) + print("The response of ConnectorsApi->update_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) +- path: /connectors/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#get-connector-correlation-config + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + # Get Connector Correlation Configuration + + try { + Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-correlation-config + source: | + 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 Correlation Configuration + + api_response = api_instance.get_connector_correlation_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_correlation_config(script_name) + print("The response of ConnectorsApi->get_connector_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) +- path: /connectors/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/connectors#put-connector-correlation-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 correlation config xml file + + # Update Connector Correlation Configuration + + try { + Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-correlation-config + source: | + 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 correlation config xml file # bytearray | connector correlation config xml file + try: + # Update Connector Correlation Configuration + + api_response = api_instance.put_connector_correlation_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_correlation_config(script_name, file) + print("The response of ConnectorsApi->put_connector_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorSourceConfig -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-config + source: | + 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 + + api_response = api_instance.get_connector_source_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-config + source: | + 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 + + api_response = api_instance.put_connector_source_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorSourceTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-template + source: | + 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 + + api_response = api_instance.get_connector_source_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-template + source: | + 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 + + api_response = api_instance.put_connector_source_template(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-translations + source: | + 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 + + api_response = api_instance.get_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-translations + source: | + 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 + + api_response = api_instance.put_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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" + } ] + } + "@ + + # Creates a form definition. + + try { + New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_definition(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-definitions-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 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. + + api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-dynamic-schema + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-file-request + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID + x_sail_point_experimental = 'true' # 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 | File specifying the multipart # bytearray | File specifying the multipart + try: + # Upload new form definition file. + + api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 + } + "@ + + # Creates a form instance. + + try { + New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-instance + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_instance(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_instance(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-instances-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 form instances by tenant. + + api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental) + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#delete-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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: + # Deletes a form definition. + + api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-definition-by-key + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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: + # Return a form definition. + + api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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}]"@ + + + # Patch a form definition. + + try { + Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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') + 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) + 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. + + api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, Result) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#export-form-definitions-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 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. + + api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-file-from-s3 + source: | + 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. + x_sail_point_experimental = 'true' # 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: + # Download definition file by fileId. + + api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-by-key + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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 a form instance. + + api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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}}]"@ + + + # Patch a form instance. + + try { + Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-instance + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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') + 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) + 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. + + api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, Result) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-file + source: | + 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. + x_sail_point_experimental = 'true' # 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: + # Download instance file by fileId. + + api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + + + + + + $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}}]"@ + + + # Import form definitions from export. + + try { + Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#import-form-definitions + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + 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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + + try: + # Import form definitions from export. + + api_response = api_instance.import_form_definitions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_form_definitions(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # Retrieves dynamic data by element. + + try { + Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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 + x_sail_point_experimental = 'true' # 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 | 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. + + api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, limit, filters, query) + print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-pre-defined-select-options + source: | + x_sail_point_experimental = 'true' # 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 predefined select options. + + api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental) + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#show-preview-data-source + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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 = 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. + + api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, limit, filters, query, Result) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#create-custom-password-instructions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CustomPasswordInstruction = @" + { + "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" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#create-custom-password-instructions + source: | + x_sail_point_experimental = 'true' # 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 + Result = custom_password_instruction.from_json(custom_password_instruction) + api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#delete-custom-password-instructions + source: | + 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 + + api_instance.delete_custom_password_instructions(page_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#get-custom-password-instructions + source: | + 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 + + api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) +- path: /data-segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#create-data-segment + source: | + $DataSegment = @" + + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment + New-V2024DataSegment -DataSegment $Result + + # Below is a request that includes all optional parameters + # New-V2024DataSegment -DataSegment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#create-data-segment + source: | + data_segment = sailpoint.v2024.DataSegment() # DataSegment | + try: + # Create Segment + Result = data_segment.from_json(data_segment) + api_response = api_instance.create_data_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_data_segment(Result) + print("The response of DataSegmentationApi->create_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) +- path: /data-segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#list-data-segments + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true) + $Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false) + $Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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 = "name eq """ # 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* (optional) + + # Get Segments + + try { + Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#list-data-segments + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) + unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) + published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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 = 'name 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, in, sw* **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, sw* **name**: *eq, in, sw* (optional) + try: + # Get Segments + + api_response = api_instance.list_data_segments(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) + print("The response of DataSegmentationApi->list_data_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) +- path: /data-segments/{segmentId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#delete-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) + + # Delete Segment by ID + + try { + Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#delete-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID 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') + published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False) + try: + # Delete Segment by ID + + api_instance.delete_data_segment(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_data_segment(id, x_sail_point_experimental, published) + except Exception as e: + print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) +- path: /data-segments/{segmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Segment by ID + + try { + Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + x_sail_point_experimental = 'true' # 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 Segment by ID + + api_response = api_instance.get_data_segment(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segment(id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) +- path: /data-segments/{segmentId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#patch-data-segment + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 * membership * memberFilter * memberSelection * scopes * enabled + $RequestBody = @"[{op=replace, path=/memberFilter, 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-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#patch-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + x_sail_point_experimental = 'true' # 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 = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + request_body = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + + try: + # Update Segment + Result = request_body.from_json(request_body) + api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) + print("The response of DataSegmentationApi->patch_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) +- path: /data-segments/{segmentId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#publish-data-segment + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish + $RequestBody = @""@ + + $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) + + # Publish segment by ID + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#publish-data-segment + source: | + x_sail_point_experimental = 'true' # 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] | A list of segment ids that you wish to publish + request_body = ['request_body_example'] # List[str] | A list of segment ids that you wish to publish + + publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) + try: + # Publish segment by ID + Result = request_body.from_json(request_body) + api_instance.publish_data_segment(x_sail_point_experimental, Result, ) + + # Below is a request that includes all optional parameters + # api_instance.publish_data_segment(x_sail_point_experimental, Result, publish_all) + except Exception as e: + print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) +- path: /data-segments/membership/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment-identity-membership + source: | + $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get SegmentMembership by Identity ID + + try { + Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment-identity-membership + source: | + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. + x_sail_point_experimental = 'true' # 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 SegmentMembership by Identity ID + + api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) +- path: /data-segments/user-enabled/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Is Segmentation enabled by Identity + + try { + Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. + x_sail_point_experimental = 'true' # 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: + # Is Segmentation enabled by Identity + + api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) +- path: /roles/{roleId}/dimensions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#create-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $Dimension = @" + { + "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" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "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.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } + "@ + + # Create a Dimension + + try { + $Result = ConvertFrom-JsonToDimension -Json $Dimension + New-V2024Dimension -RoleId $RoleId -Dimension $Result + + # Below is a request that includes all optional parameters + # New-V2024Dimension -RoleId $RoleId -Dimension $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#create-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension = { + "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" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "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.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } # Dimension | + try: + # Create a Dimension + Result = dimension.from_json(dimension) + api_response = api_instance.create_dimension(role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_dimension(role_id, Result) + print("The response of DimensionsApi->create_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#list-dimensions + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $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 = "id eq '2c918086749d78830174a1a40e121518'" # 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* (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) + + # List Dimensions + + try { + Get-V2024Dimensions -RoleId $RoleId + + # Below is a request that includes all optional parameters + # Get-V2024Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimensions + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + 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 = 'id eq \'2c918086749d78830174a1a40e121518\'' # 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* (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* (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) + try: + # List Dimensions + + api_response = api_instance.list_dimensions(role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimensions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) +- path: /roles/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#delete-bulk-dimensions + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. + $DimensionBulkDeleteRequest = @" + { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Dimension(s) + + try { + $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest + Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-bulk-dimensions + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. + dimension_bulk_delete_request = { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # DimensionBulkDeleteRequest | + try: + # Delete Dimension(s) + Result = dimension_bulk_delete_request.from_json(dimension_bulk_delete_request) + api_response = api_instance.delete_bulk_dimensions(role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_dimensions(role_id, Result) + print("The response of DimensionsApi->delete_bulk_dimensions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#delete-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Delete a Dimension + + try { + Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + try: + # Delete a Dimension + + api_instance.delete_dimension(role_id, dimension_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_dimension(role_id, dimension_id) + except Exception as e: + print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#get-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Get a Dimension under Role. + + try { + Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + try: + # Get a Dimension under Role. + + api_response = api_instance.get_dimension(role_id, dimension_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dimension(role_id, dimension_id) + print("The response of DimensionsApi->get_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#patch-dimension + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Dimension + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#patch-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + [{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Dimension + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_dimension(role_id, dimension_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_dimension(role_id, dimension_id, Result) + print("The response of DimensionsApi->patch_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#get-dimension-entitlements + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $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 = "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 Dimension's Entitlements + + try { + Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension-entitlements + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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* (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 Dimension's Entitlements + + api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->get_dimension_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/dimensions#list-dimension-access-profiles + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $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 = "source.id eq "2c91808982f979270182f99e386d00fa"" # 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* **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, created, modified** (optional) + + # List Dimension's Access Profiles + + try { + Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimension-access-profiles + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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 = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # 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* **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* **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, 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 Dimension's Access Profiles + + api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimension_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Add metadata to an entitlement. + + try { + New-V2024AccessModelMetadataForEntitlement -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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. + + api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove metadata from an entitlement. + + try { + Remove-V2024AccessModelMetadataFromEntitlement -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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. + + api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get an entitlement + + try { + Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement + source: | + 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 + + api_response = api_instance.get_entitlement(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#patch-entitlement + source: | + 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') + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch an entitlement + + api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, Result) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Entitlement Request Config + + try { + Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement-request-config + source: | + 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 + + api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $EntitlementRequestConfig = @" + { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#put-entitlement-request-config + source: | + 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 + Result = entitlement_request_config.from_json(entitlement_request_config) + api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#import-entitlements-by-source + source: | + 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 + + api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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 = "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: **id, name, created, modified, type, attribute, value, source.id** (optional) + $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, 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) + + # List of entitlements children + + try { + Get-V2024EntitlementChildren -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-children + source: | + 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 + + api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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 = "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: **id, name, created, modified, type, attribute, value, source.id** (optional) + $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, 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) + + # List of entitlements parents + + try { + Get-V2024EntitlementParents -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-parents + source: | + 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 + + api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $SegmentedForIdentity = "me" # String | 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) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | 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) + $IncludeUnsegmented = $true # Boolean | 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 # 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) + $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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $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, 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) + + # Gets a list of entitlements. + + try { + Get-V2024Entitlements -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlements + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.list_entitlements(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Reset Source Entitlements + + try { + Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#reset-source-entitlements + source: | + 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 + + api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#update-entitlements-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + 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. + Result = network_configuration.from_json(network_configuration) + api_response = api_instance.create_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + + # Get security network configuration. + + try { + Get-V2024AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + try: + # Get security network configuration. + + api_response = api_instance.get_auth_org_network_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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. + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#create-workgroup + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupDto = @" + { + "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" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#create-workgroup + source: | + x_sail_point_experimental = 'true' # 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. + Result = workgroup_dto.from_json(workgroup_dto) + api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $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 "Test"" # 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, sw, in* **memberships.identityId**: *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, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-V2024Workgroups -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroups + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_workgroups(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete a Governance Group + + try { + Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup + source: | + 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 + + api_instance.delete_workgroup(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_workgroup(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Governance Group by Id + + try { + Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#get-workgroup + source: | + 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 + + api_response = api_instance.get_workgroup(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workgroup(id, x_sail_point_experimental) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#patch-workgroup + source: | + 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') + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch a Governance Group + + api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $IdentityPreviewResponseIdentity = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup-members + source: | + 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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + + try: + # Remove members from Governance Group + Result = identity_preview_response_identity.from_json(identity_preview_response_identity) + api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroups-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroups-in-bulk + source: | + x_sail_point_experimental = 'true' # 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) + Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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 = 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) + $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 = "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) + + # List connections for Governance Group + + try { + Get-V2024Connections -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-connections + source: | + 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 + + api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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 = 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) + $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 = "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) + + # List Governance Group Members + + try { + Get-V2024WorkgroupMembers -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroup-members + source: | + 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 + + api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $IdentityPreviewResponseIdentity = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#update-workgroup-members + source: | + 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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + + try: + # Add members to Governance Group + Result = identity_preview_response_identity.from_json(identity_preview_response_identity) + api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Ignored Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Ignored Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 "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 + + try { + Get-V2024AccessRequestRecommendationsIgnoredItems -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + x_sail_point_experimental = 'true' # 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 of Ignored Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_ignored_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Requested Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Requested Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # List of Requested Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsRequestedItems -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 of Requested Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_requested_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Viewed Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # List of Viewed Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsViewedItems -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 of Viewed Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_viewed_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Notification of Viewed Access Request Recommendations in Bulk + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + try: + # Notification of Viewed Access Request Recommendations in Bulk + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + + # Identity Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendations -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 + + api_response = api_instance.get_access_request_recommendations(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) +- path: /ai-access-request-recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) +- path: /ai-access-request-recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @" + { + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + } + "@ + + # Update Access Request Recommendations config + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto + Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = access_request_recommendation_config_dto.from_json(access_request_recommendation_config_dto) + api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#create-common-access + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#create-common-access + source: | + x_sail_point_experimental = 'true' # 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 + Result = common_access_item_request.from_json(common_access_item_request) + api_response = api_instance.create_common_access(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_common_access(x_sail_point_experimental, Result) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "access.type eq "ROLE"" # 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (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, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-V2024CommonAccess -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#get-common-access + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_common_access(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#update-common-access-status-in-bulk + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + try: + # Bulk update common access status + Result = common_access_id_status.from_json(common_access_id_status) + api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # IAI Identity Outliers Export + + try { + Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#export-outliers-zip + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.export_outliers_zip(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_outliers_zip(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # 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: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # 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: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-V2024IdentityOutlierSnapshots -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outlier-snapshots + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # 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: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-V2024IdentityOutliers -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_identity_outliers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # IAI Identity Outliers Latest Summary + + try { + Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get identity outlier contibuting feature summary + + try { + Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + 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 + + api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # 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: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-V2024PeerGroupOutliersContributingFeatures -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + 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 + + api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#ignore-identity-outliers + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#ignore-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Ignore + Result = request_body.from_json(request_body) + api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $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) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # 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: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-V2024OutliersContributingFeatureAccessItems -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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 + + api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#un-ignore-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Unignore + Result = request_body.from_json(request_body) + api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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) + + # Identity Outliers List + + try { + Get-V2024PeerGroupOutliers -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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 + + api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns a Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations + source: | + x_sail_point_experimental = 'true' # 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 a Recommendation Based on Object + Result = recommendation_request_dto.from_json(recommendation_request_dto) + api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_recommendations_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations_config(x_sail_point_experimental) + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#update-recommendations-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#update-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = recommendation_config_dto.from_json(recommendation_config_dto) + api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-V2024PotentialRoleProvisionRequest -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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. + + api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, Result) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-role-mining-sessions + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningSessionDto = @" + { + "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" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-role-mining-sessions + source: | + x_sail_point_experimental = 'true' # 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 + Result = role_mining_session_dto.from_json(role_mining_session_dto) + api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Sorters = "createdBy,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: **createdBy, createdDate** (optional) + $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) + + # Retrieves all role mining sessions + + try { + Get-V2024RoleMiningSessions -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-sessions + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-V2024DownloadRoleMiningPotentialRoleZip -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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 + + api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # 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 + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve status of a potential role export job + + try { + Export-V2024RoleMiningPotentialRoleStatus -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved 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: **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 # 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) + + # Retrieves all potential role summaries + + try { + Get-V2024AllPotentialRoleSummaries -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-all-potential-role-summaries + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_all_potential_role_summaries(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-V2024EntitlementDistributionPotentialRole -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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 + + api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $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) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-V2024EntitlementsPotentialRole -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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 + + api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "populariity" # 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: **popularity** (optional) + $Filters = "applicationName sw "AD"" # 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $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) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-V2024ExcludedEntitlementsPotentialRole -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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 + + api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 = "MyFilters" # 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* (optional) + $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) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-V2024IdentitiesPotentialRole -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-identities-potential-role + source: | + 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 + + api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role + source: | + 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 + + api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{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}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role + source: | + 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') + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "applicationName sw "test"" # 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: **applicationName**: *sw* (optional) + $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) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-V2024PotentialRoleApplications -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-applications + source: | + 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 + + api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "entitlementRef.name sw "test"" # 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: **entitlementRef.name**: *sw* (optional) + $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) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-V2024PotentialRoleEntitlements -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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 + + api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "-usageCount" # 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: **displayName, email, usageCount** (optional) + $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) + + # Retrieves potential role source usage + + try { + Get-V2024PotentialRoleSourceIdentityUsage -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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 + + api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved 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: **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 # 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) + + # Retrieves all potential role summaries + + try { + Get-V2024PotentialRoleSummaries -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-summaries + source: | + 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 + + api_response = api_instance.get_potential_role_summaries(session_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Retrieves a specific potential role + + try { + Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-potential-role + source: | + 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 + + api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{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}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole0 -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role-0 + source: | + 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') + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get a role mining session + + try { + Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session + source: | + 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 + + api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-role-mining-session + source: | + 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') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get role mining session status state + + try { + Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session-status + source: | + 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 + + api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + + # Retrieves all saved potential roles + + try { + Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SavedPotentialRoles -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-saved-potential-roles + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-V2024EntitlementsPotentialRole -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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 + Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/icons#delete-icon + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete an icon + + try { + Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/icons#delete-icon + source: | + 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 + + api_instance.delete_icon(object_type, object_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_icon(object_type, object_id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/icons#set-icon + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-V2024Icon -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/icons#set-icon + source: | + 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 + + api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image) + print("The response of IconsApi->set_icon:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#delete-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete identity + + try { + Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#delete-identity + source: | + 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 + + api_instance.delete_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Identity Details + + try { + Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-identity + source: | + 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 + + api_response = api_instance.get_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity(id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get ownership details + + try { + Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-identity-ownership-details + source: | + 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 + + api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignment + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Role assignment details + + try { + Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignment + source: | + 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 + + api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignments + source: | + 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 + + api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Sorters = "name,-cloudStatus" # 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, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | 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 = $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) + $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 Identities + + try { + Get-V2024Identities -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#list-identities + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#reset-identity + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset an identity + + try { + Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#reset-identity + source: | + 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 + + api_instance.reset_identity(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.reset_identity(identity_id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#send-identity-verification-account-token + source: | + x_sail_point_experimental = 'true' # 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 + Result = send_account_verification_request.from_json(send_account_verification_request) + api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identities-invite + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#start-identities-invite + source: | + x_sail_point_experimental = 'true' # 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 + Result = invite_identities_request.from_json(invite_identities_request) + api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identity-processing + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#start-identity-processing + source: | + x_sail_point_experimental = 'true' # 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 + Result = process_identities_request.from_json(process_identities_request) + api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Attribute synchronization for single identity. + + try { + Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#synchronize-attributes-for-identity + source: | + 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. + + api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#create-identity-attribute + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "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 + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#create-identity-attribute + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $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 Identity Attributes + + try { + Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttributes -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#list-identity-attributes + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_identity_attributes(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete Identity Attribute + + try { + Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attribute + source: | + 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 + + api_instance.delete_identity_attribute(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attribute(name, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Identity Attribute + + try { + Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#get-identity-attribute + source: | + 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 + + api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $IdentityAttribute = @" + { + "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 + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#put-identity-attribute + source: | + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_attribute_names.from_json(identity_attribute_names) + api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | 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 # 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) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshots -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots + source: | + 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) + + 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 + + api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessAssociated = $false # Boolean | 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" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (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) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshotsAccessType -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 + + api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get latest snapshot of identity + + try { + Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity + source: | + 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 + + api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, 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) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-V2024HistoricalIdentityEvents -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity-events + source: | + 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) + + 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) + + 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 + + api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets an identity snapshot at a given date + + try { + Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot + source: | + 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 + + api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (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) + + # Gets the summary for the event count for a specific identity + + try { + Get-V2024IdentitySnapshotSummary -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot-summary + source: | + 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 + + api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Gets the start date of the identity + + try { + Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-start-date + source: | + 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 + + api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (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) + + # Lists all the identities + + try { + Get-V2024HistoricalIdentities -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-historical-identities + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_historical_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (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) + $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) + $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 Access Items by Identity + + try { + Get-V2024IdentityAccessItems -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-access-items + source: | + 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 + + api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The access item type (optional) + + # Gets the list of identity access items at a given date filterd by item type + + try { + Get-V2024IdentitySnapshotAccessItems -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshot-access-items + source: | + 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 + + api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-V2024IdentitySnapshots -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshots + source: | + 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 + + api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024IdentityProfile -IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityProfile -IdentityProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#create-identity-profile + source: | + 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 + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#list-identity-profiles + 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) + 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + + # Delete Identity Profile + + try { + Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + + # Get Identity Profile + + try { + Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024IdentityProfiles -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfiles -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#export-identity-profiles + 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) + 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#generate-identity-preview + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 + New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#generate-identity-preview + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) + print("The response of IdentityProfilesApi->generate_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024IdentityProfiles -IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.v2024.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#sync-identity-profile + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#create-lifecycle-state + source: | + 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 + Result = lifecycle_state.from_json(lifecycle_state) + api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024LifecycleStates -IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#delete-lifecycle-state + source: | + 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 + + api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-state + source: | + 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 + + api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#set-lifecycle-state + source: | + identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update. + set_lifecycle_state_request = sailpoint.v2024.SetLifecycleStateRequest() # SetLifecycleStateRequest | + try: + # Set Lifecycle State + Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request) + api_response = api_instance.set_lifecycle_state(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_lifecycle_state(identity_id, Result) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +- path: /machine-accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Machine Account Details + + try { + Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#get-machine-account + source: | + 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 + + api_response = api_instance.get_machine_account(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_machine_account(id, x_sail_point_experimental) + print("The response of MachineAccountsApi->get_machine_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) +- path: /machine-accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @"{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}]}}"@ + + + # Update a Machine Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#update-machine-account + source: | + 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. + 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. + + try: + # Update a Machine Account + Result = request_body.from_json(request_body) + api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) + print("The response of MachineAccountsApi->update_machine_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) +- path: /machine-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccounts -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#list-machine-accounts + source: | + x_sail_point_experimental = 'true' # 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* **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) # 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* **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) + 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 + + api_response = api_instance.list_machine_accounts(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of MachineAccountsApi->list_machine_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) +- path: /machine-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MachineIdentity = @" + { + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + } + "@ + + # Create Machine Identities + + try { + $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity + New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + + # Below is a request that includes all optional parameters + # New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#create-machine-identity + source: | + x_sail_point_experimental = 'true' # 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 + Result = machine_identity.from_json(machine_identity) + api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) + print("The response of MachineIdentitiesApi->create_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) +- path: /machine-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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) + $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 Machine Identities + + try { + Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#list-machine-identities + source: | + x_sail_point_experimental = 'true' # 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 = '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 + + api_response = api_instance.list_machine_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset) + print("The response of MachineIdentitiesApi->list_machine_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) +- path: /machine-identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete machine identity + + try { + Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#delete-machine-identity + source: | + 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 + + api_instance.delete_machine_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_machine_identity(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) +- path: /machine-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Machine Identity Details + + try { + Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#get-machine-identity + source: | + 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 + + api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) + print("The response of MachineIdentitiesApi->get_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) +- path: /machine-identities/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{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}]}}"@ + + + # Update a Machine Identity + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#update-machine-identity + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) + print("The response of MachineIdentitiesApi->update_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#create-managed-client + source: | + managed_client_request = { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } # ManagedClientRequest | + try: + # Create Managed Client + Result = managed_client_request.from_json(managed_client_request) + api_response = api_instance.create_managed_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_client(Result) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-clients + source: | + 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 + + api_response = api_instance.get_managed_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-V2024ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#delete-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + api_instance.delete_managed_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-V2024ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + api_response = api_instance.get_managed_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#update-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Client + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client(id, Result) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client-status + source: | + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v2024.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster + source: | + 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 + Result = managed_cluster_request.from_json(managed_cluster_request) + api_response = api_instance.create_managed_cluster(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_cluster(Result) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-clusters + source: | + 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 + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#delete-managed-cluster + source: | + 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 + + api_instance.delete_managed_cluster(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Cluster + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_cluster(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_cluster(id, Result) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-client-log-configuration + source: | + 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 + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#put-client-log-configuration + source: | + 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.v2024.PutClientLogConfigurationRequest() # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request) + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + 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 + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequests -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSources + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + 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 + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-V2024NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.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/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecord -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + delete_non_employee_records_in_bulk_request = sailpoint.v2024.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + api_instance.delete_non_employee_records_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_records_in_bulk(Result) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + 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 + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequest -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + 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 + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + 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 + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + 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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-V2024NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-V2024NonEmployeeSource -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-V2024NonEmployeeRecords -Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeApproval -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeBulkUploadStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + 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 + + api_response = api_instance.list_non_employee_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + 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 + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-domain-dkim + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-domain-dkim + source: | + x_sail_point_experimental = 'true' # 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 + Result = domain_address.from_json(domain_address) + api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-dkim-attributes + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_dkim_attributes(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dkim_attributes(x_sail_point_experimental) + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-notification-template + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateDto = @" + { + "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" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-notification-template + source: | + x_sail_point_experimental = 'true' # 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 + Result = template_dto.from_json(template_dto) + api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $Filters = "medium eq "EMAIL"" # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-templates + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_notification_templates(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_templates(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-verified-from-address + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-verified-from-address + source: | + x_sail_point_experimental = 'true' # 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 + Result = email_status_dto.from_json(email_status_dto) + api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "email eq "john.doe@company.com"" # 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: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # 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: **email** (optional) + + # List From Addresses + + try { + Get-V2024FromAddresses -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-from-addresses + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_from_addresses(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-notification-templates-in-bulk + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#delete-notification-templates-in-bulk + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) + api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-verified-from-address + source: | + $Id = "MyId" # String | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Verified From Address + + try { + Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#delete-verified-from-address + source: | + 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 + + api_instance.delete_verified_from_address(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get MAIL FROM Attributes + + try { + Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-mail-from-attributes + source: | + 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 + + api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Notification Template By Id + + try { + Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-notification-template + source: | + 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 + + api_response = api_instance.get_notification_template(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notification_template(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-notifications-template-context + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_notifications_template_context(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notifications_template_context(x_sail_point_experimental) + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-preferences + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.list_notification_preferences(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_preferences(x_sail_point_experimental) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $Filters = "key eq "cloud_manual_work_item_summary"" # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-template-defaults + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#put-mail-from-attributes + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#put-mail-from-attributes + source: | + x_sail_point_experimental = 'true' # 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 + Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) + api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/notifications#send-test-notification + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#send-test-notification + source: | + x_sail_point_experimental = 'true' # 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 + Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) + api_instance.send_test_notification(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_test_notification(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024OauthClient -CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024OauthClient -CreateOAuthClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#create-oauth-client + source: | + 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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024OauthClients + + # Below is a request that includes all optional parameters + # Get-V2024OauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#delete-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-V2024OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/o-auth-clients#get-oauth-client + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-V2024OauthClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024OauthClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#get-org-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_org_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_org_config(x_sail_point_experimental) + print("The response of OrgConfigApi->get_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/org-config#patch-org-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Org Config + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#patch-org-config + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 Valid Time Zones + + try { + Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#get-valid-time-zones + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, limit, offset, count) + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-V2024PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-V2024PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-V2024PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-V2024PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-V2024PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#create-digit-token + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#create-digit-token + source: | + x_sail_point_experimental = 'true' # 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 + Result = password_digit_token_reset.from_json(password_digit_token_reset) + api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#get-password-change-status + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-V2024PasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#get-password-change-status + source: | + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + api_response = api_instance.get_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-management#set-password + source: | + $PasswordChangeRequest = @" + { + "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==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-V2024Password -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024Password -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#set-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password(Result) + print("The response of PasswordManagementApi->set_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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" : 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 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/password-policies#delete-password-policy + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-V2024PasswordPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordPolicyById -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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" : 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 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordSyncGroup -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordSyncGroup -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordSyncGroup -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-V2024PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/personal-access-tokens#delete-personal-access-token + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-V2024PersonalAccessToken -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.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/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PublicIdentities + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/public-identities#get-public-identities + 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) + 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 + + api_response = api_instance.get_public_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/public-identities-config#get-public-identity-config + source: | + + # Get the Public Identities Configuration + + try { + Get-V2024PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get the Public Identities Configuration + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024PublicIdentityConfig -PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/public-identities-config#update-public-identity-config + source: | + 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 + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#cancel-report + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-V2024Report -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#cancel-report + source: | + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + api_instance.cancel_report(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | 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) + + # Get Report File + + try { + Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report + source: | + 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 + + api_response = api_instance.get_report(task_result_id, file_format, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report-result + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-V2024ReportResult -TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-V2024ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report-result + source: | + 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 + + api_response = api_instance.get_report_result(task_result_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#start-report + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-V2024Report -ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-V2024Report -ReportDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#start-report + source: | + report_details = { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } # ReportDetails | + try: + # Run Report + Result = report_details.from_json(report_details) + api_response = api_instance.start_report(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_report(Result) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024RequestableObjects + + # Below is a request that includes all optional parameters + # Get-V2024RequestableObjects -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-V2024RequestableObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/requestable-objects#list-requestable-objects + source: | + 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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#create-role-insight-requests + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.create_role_insight_requests(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_insight_requests(x_sail_point_experimental) + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Sorters = "identitiesWithAccess" # 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # 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* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#download-role-insights-entitlements-changes + source: | + 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 + + api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $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) + $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 sw "Jan"" # 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* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-V2024EntitlementChangesIdentities -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-entitlement-changes-identities + source: | + 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) + + api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get a single role insight + + try { + Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insight + source: | + 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 + + api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $Sorters = "numberOfUpdates" # 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-V2024RoleInsights -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_insights(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $Filters = "name sw "r"" # 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* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-current-entitlements + source: | + 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 + + api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $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: **identitiesWithAccess, name** (optional) + $Filters = "name sw "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: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-entitlements-changes + source: | + 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 + + api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Returns metadata from prior request. + + try { + Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-requests + source: | + 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. + + api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-summary + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_insights_summary(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_summary(x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Role -Role $Result + + # Below is a request that includes all optional parameters + # New-V2024Role -Role $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Roles + + # Below is a request that includes all optional parameters + # Get-V2024Roles -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-V2024Roles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-bulk-roles + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove a Metadata From Role. + + try { + Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + 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. + + api_instance.delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add a Metadata to Role. + + try { + Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-attribute-key-and-value-to-role + source: | + 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. + + api_response = api_instance.update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-V2024Role -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-V2024Role -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Role -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Role -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status + source: | + + # Get Bulk-Update Statuses + + try { + Get-V2024BulkUpdateStatus + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status + source: | + try: + # Get Bulk-Update Statuses + + api_response = api_instance.get_bulk_update_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_bulk_update_status() + print("The response of RolesApi->get_bulk_update_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatusById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status-by-id + source: | + 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 + + api_response = api_instance.get_bulk_update_status_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_bulk_update_status_by_id(id) + print("The response of RolesApi->get_bulk_update_status_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024RoleAssignedIdentities -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role-assigned-identities + source: | + 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 + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $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 = "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 + + try { + Get-V2024RoleEntitlements -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role-entitlements + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing 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') + 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* (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 + + api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) +- path: /roles/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "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) + $RoleListFilterDTO = @" + { + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + } + "@ + + # Filter Roles by Metadata + + try { + Search-V2024RolesByFilter + + # 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#search-roles-by-filter + source: | + 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 + + api_response = api_instance.search_roles_by_filter() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, Result) + print("The response of RolesApi->search_roles_by_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-filter + source: | + $RoleMetadataBulkUpdateByFilterRequest = @" + { + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Filters + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest + Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-filter + source: | + 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 + Result = role_metadata_bulk_update_by_filter_request.from_json(role_metadata_bulk_update_by_filter_request) + api_response = api_instance.update_roles_metadata_by_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_filter(Result) + print("The response of RolesApi->update_roles_metadata_by_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-ids + source: | + $RoleMetadataBulkUpdateByIdRequest = @" + { + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by ID + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest + Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-ids + source: | + 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 + Result = role_metadata_bulk_update_by_id_request.from_json(role_metadata_bulk_update_by_id_request) + api_response = api_instance.update_roles_metadata_by_ids(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_ids(Result) + print("The response of RolesApi->update_roles_metadata_by_ids:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-query + source: | + $RoleMetadataBulkUpdateByQueryRequest = @" + { + "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" + } + "@ + + # Bulk-Update Roles' Metadata by Query + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest + Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-query + source: | + 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 + Result = role_metadata_bulk_update_by_query_request.from_json(role_metadata_bulk_update_by_query_request) + api_response = api_instance.update_roles_metadata_by_query(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_query(Result) + print("The response of RolesApi->update_roles_metadata_by_query:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "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" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration + source: | + x_sail_point_experimental = 'true' # 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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.get_sim_integrations(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + 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 + + api_instance.delete_sim_integration(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + 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. + + api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + 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. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $SimIntegrationDetails = @" + { + "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" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + 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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + 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. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "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" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (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, description** (optional) + + # List SOD policies + + try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + 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 + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + 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 + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "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" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + 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 + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 = @" + { + "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 + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + 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 + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + 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 + + api_response = api_instance.start_evaluate_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + 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 + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + 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 + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "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" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + 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 + Result = identity_with_new_access1.from_json(identity_with_new_access1) + api_response = api_instance.start_violation_check(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_violation_check(Result) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + export_payload = { + "description" : "Export Job 1 Test" + } # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + Result = export_payload.from_json(export_payload) + api_response = api_instance.export_sp_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_sp_config(Result) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + 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. + + api_response = api_instance.get_sp_config_export(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + 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 + + api_response = api_instance.get_sp_config_export_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + 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 + + api_response = api_instance.get_sp_config_import(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + 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 + + api_response = api_instance.get_sp_config_import_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + 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 + + api_response = api_instance.import_sp_config(data, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + + # Get config object details + + try { + Get-V2024SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + try: + # Get config object details + + api_response = api_instance.list_sp_config_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch -CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024SavedSearch -CreateSavedSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#create-saved-search + source: | + create_saved_search_request = sailpoint.v2024.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + Result = create_saved_search_request.from_json(create_saved_search_request) + api_response = api_instance.create_saved_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_saved_search(Result) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024SavedSearches + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#list-saved-searches + source: | + 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 + + api_response = api_instance.list_saved_searches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-V2024SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#delete-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + api_instance.delete_saved_search(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-V2024SavedSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#get-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + api_response = api_instance.get_saved_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024SavedSearch -Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-V2024SavedSearch -Id $Id -SavedSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#put-saved-search + source: | + 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 + Result = saved_search.from_json(saved_search) + api_response = api_instance.put_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_saved_search(id, Result) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#execute-saved-search + source: | + 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 + Result = search_arguments.from_json(search_arguments) + api_instance.execute_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.execute_saved_search(id, Result) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ScheduledSearch -CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#create-scheduled-search + source: | + 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 + Result = create_scheduled_search_request.from_json(create_scheduled_search_request) + api_response = api_instance.create_scheduled_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_scheduled_search(Result) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#list-scheduled-search + source: | + 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 + + api_response = api_instance.list_scheduled_search() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-V2024ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#delete-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + api_instance.delete_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-V2024ScheduledSearch -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#get-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + api_response = api_instance.get_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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" : { + "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 + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#update-scheduled-search + source: | + 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 + Result = scheduled_search.from_json(scheduled_search) + api_response = api_instance.update_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_scheduled_search(id, Result) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#unsubscribe-scheduled-search + source: | + 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 + Result = typed_reference.from_json(typed_reference) + api_instance.unsubscribe_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.unsubscribe_scheduled_search(id, Result) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Aggregate -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_aggregate(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_aggregate(Result, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Count -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Count -Search $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } + } + } # Search | + try: + # Count Documents Satisfying a Query + Result = search.from_json(search) + api_instance.search_count(Result) + + # Below is a request that includes all optional parameters + # api_instance.search_count(Result) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Get -Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-V2024Get -Index $Index -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search#search-get + source: | + 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 + + api_response = api_instance.search_get(index, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Post -Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_post(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_post(Result, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#create-search-attribute-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Extended Search Attributes + + try { + Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-search-attribute-config + source: | + x_sail_point_experimental = 'true' # 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 Extended Search Attributes + + api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete Extended Search Attribute + + try { + Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Extended Search Attribute + + try { + Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + 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 + + api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#patch-search-attribute-config + source: | + 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') + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Segment -Segment $Result + + # Below is a request that includes all optional parameters + # New-V2024Segment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Segments + + # Below is a request that includes all optional parameters + # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-V2024Segment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-V2024Segment -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024Segment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Segment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#create-service-desk-integration + source: | + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integrations + source: | + 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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-V2024ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-V2024ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v2024.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-V2024ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "-date" # 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: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "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" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-V2024ProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source + source: | + $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" + } + "@ + $ProvisionAsCsv = $false # Boolean | 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) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-V2024Source -Source $Result + + # Below is a request that includes all optional parameters + # New-V2024Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 "Employees"" # 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, 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" # 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: **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) + $ForSubadmin = "name" # String | 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) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-V2024Sources + + # 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#list-sources + 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) + 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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +- path: /sources/{sourceId}/schedules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schedule1 = @" + + "@ + + # Create Schedule on Source + + try { + $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 + New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schedule + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + schedule1 = sailpoint.v2024.Schedule1() # Schedule1 | + try: + # Create Schedule on Source + Result = schedule1.from_json(schedule1) + api_response = api_instance.create_source_schedule(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schedule(source_id, Result) + print("The response of SourcesApi->create_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schedules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedules + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # List Schedules on Source + + try { + Get-V2024SourceSchedules -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedules -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedules + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # List Schedules on Source + + api_response = api_instance.get_source_schedules(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schedules(source_id) + print("The response of SourcesApi->get_source_schedules:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-V2024SourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.v2024.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-V2024SourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Remove All Accounts in a Source + + try { + Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-accounts-async + source: | + 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 + + api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete Native Change Detection Configuration + + try { + Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-native-change-detection-config + source: | + 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 + + api_instance.delete_native_change_detection_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Native Change Detection Configuration + + try { + Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-native-change-detection-config + source: | + 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 + + api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-native-change-detection-config + source: | + 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 + Result = native_change_detection_config.from_json(native_change_detection_config) + api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Delete Provisioning Policy by UsageType + + try { + Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Get Provisioning Policy by UsageType + + try { + Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $ProvisioningPolicyDto = @" + { + "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" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v2024.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-V2024Source -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-V2024Source -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | 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" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-V2024Source -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-V2024Source -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Source -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +- path: /sources/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Delete Source Schedule by type. + + try { + Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schedule + source: | + 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. + + api_instance.delete_source_schedule(source_id, schedule_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schedule(source_id, schedule_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Get Source Schedule by Type + + try { + Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedule + source: | + 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 + + api_response = api_instance.get_source_schedule(source_id, schedule_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schedule(source_id, schedule_type) + print("The response of SourcesApi->get_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schedule (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schedule + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. + [{op=replace, path=/cronExpression, value=0 0 6 * * ?}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + + try: + # Update Source Schedule (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + print("The response of SourcesApi->update_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source-schema + source: | + 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.v2024.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-V2024AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_accounts_schema(id) + + # Below is a request that includes all optional parameters + # api_instance.get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-V2024AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_accounts_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-correlation-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-V2024CorrelationConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CorrelationConfig -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-correlation-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + api_response = api_instance.get_correlation_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_correlation_config(id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#put-correlation-config + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "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" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-correlation-config + source: | + 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 + Result = correlation_config.from_json(correlation_config) + api_response = api_instance.put_correlation_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_correlation_config(id, Result) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-V2024EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-entitlements-schema + source: | + 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 + + api_instance.get_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-V2024EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-entitlements-schema + source: | + 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 + + api_response = api_instance.import_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Attribute Sync Config + + try { + Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-attr-sync-config + source: | + 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 + + api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $AttrSyncSourceConfig = @" + { + "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" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source-attr-sync-config + source: | + 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 + Result = attr_sync_source_config.from_json(attr_sync_source_config) + api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-config + source: | + 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') + locale = 'locale_example' # 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 + + api_response = api_instance.get_source_config(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_config(id, x_sail_point_experimental, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-entitlement-request-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-entitlement-request-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = source_entitlement_request_config.from_json(source_entitlement_request_config) + api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-health + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-V2024SourceHealth -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-health + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + api_response = api_instance.get_source_health(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts + source: | + 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 + + api_response = api_instance.import_accounts(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts(id, x_sail_point_experimental, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#import-connector-file + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-V2024ConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-V2024ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-connector-file + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-uncorrelated-accounts + source: | + 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 + + api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#peek-resource-objects + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + resource_objects_request = { + "maxCount" : 100, + "objectType" : "group" + } # ResourceObjectsRequest | + try: + # Peek source connector's resource objects + Result = resource_objects_request.from_json(resource_objects_request) + api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#ping-cluster + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # 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: + # Ping cluster for source connector + + api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + print("The response of SourcesApi->ping_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Synchronize single source attributes. + + try { + Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#sync-attributes-for-source + source: | + 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. + + api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#test-source-configuration + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # 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: + # Test configuration for source connector + + api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-connection + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Check connection for source connector. + + 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 + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#test-source-connection + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + x_sail_point_experimental = 'true' # 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: + # Check connection for source connector. + + api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_connection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) +- path: /sources/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-password-policy-holders + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $PasswordPolicyHoldersDtoInner = @""@ + + + # Update Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner + Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-password-policy-holders + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + password_policy_holders_dto_inner = [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + + try: + # Update Password Policy + Result = password_policy_holders_dto_inner.from_json(password_policy_holders_dto_inner) + api_response = api_instance.update_password_policy_holders(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_policy_holders(source_id, Result) + print("The response of SourcesApi->update_password_policy_holders:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "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" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v2024.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024SedBatchStats -BatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + api_response = api_instance.get_sed_batch_stats(batch_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches + source: | + + # List Sed Batch Request + + try { + Get-V2024SedBatches + + # Below is a request that includes all optional parameters + # Get-V2024SedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batches + source: | + try: + # List Sed Batch Request + + api_response = api_instance.get_sed_batches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-V2024SedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-V2024SedBatchRequest -SedBatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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 + + api_response = api_instance.submit_sed_batch_request() + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_batch_request(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "displayName co "Read and Write"" # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # 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: **displayName, sourceName, status** (optional) + $CountOnly = $false # 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. 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) + $RequestedByAnyone = $false # Boolean | 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) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) + + # List Suggested Entitlement Descriptions + + try { + Get-V2024Seds + + # 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#list-seds + 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) + 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 + + api_response = api_instance.list_seds() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#patch-sed + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-V2024Sed -Id $Id -SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024Sed -Id $Id -SedPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#patch-sed + source: | + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + [sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + try: + # Patch Suggested Entitlement Description + Result = sed_patch.from_json(sed_patch) + api_response = api_instance.patch_sed(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sed(id, Result) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-V2024SedApproval -SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedApproval -SedApproval $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-approval + source: | + [sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + try: + # Submit Bulk Approval Request + Result = sed_approval.from_json(sed_approval) + api_response = api_instance.submit_sed_approval(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_approval(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-V2024SedAssignment -SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedAssignment -SedAssignment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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 + Result = sed_assignment.from_json(sed_assignment) + api_response = api_instance.submit_sed_assignment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_assignment(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Delete Object Tags + + try { + Remove-V2024TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Get Tagged Object + + try { + Get-V2024TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tags-to-many-object + source: | + 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 + Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "tagName eq "BU_FINANCE"" # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-V2024TaggedObjects + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-V2024TagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "objectRef.id 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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-V2024TaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjectsByType -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tags-to-many-objects + source: | + 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 + Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + + # Retrieve Pending Task List Headers + + try { + Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-task-headers + source: | + x_sail_point_experimental = 'true' # 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 + + api_instance.get_pending_task_headers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + + # Retrieve Pending Task Status List + + try { + Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-tasks + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_pending_tasks(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_tasks(x_sail_point_experimental, offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Task Status by ID + + try { + Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status + source: | + 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 + + api_response = api_instance.get_task_status(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status(id, x_sail_point_experimental) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#update-task-status + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + try: + # Update Task Status by ID + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "completionStatus eq "Success"" # 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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** (optional) + + # Retrieve Task Status List + + try { + Get-V2024TaskStatusList -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status-list + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_task_status_list(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant + source: | + + # Get Tenant Information. + + try { + Get-V2024Tenant + + # Below is a request that includes all optional parameters + # Get-V2024Tenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tenant#get-tenant + source: | + try: + # Get Tenant Information. + + api_response = api_instance.get_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-V2024Transform -Transform $Result + + # Below is a request that includes all optional parameters + # New-V2024Transform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # 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: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-V2024Transforms + + # Below is a request that includes all optional parameters + # Get-V2024Transforms -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-V2024Transform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-V2024Transform -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-V2024Transform -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024Transform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#complete-trigger-invocation + source: | + 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 + Result = complete_invocation.from_json(complete_invocation) + api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#create-subscription + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPostRequest = @" + { + "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 + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#create-subscription + source: | + x_sail_point_experimental = 'true' # 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 + Result = subscription_post_request.from_json(subscription_post_request) + api_response = api_instance.create_subscription(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_subscription(x_sail_point_experimental, Result) + print("The response of TriggersApi->create_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # 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* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # 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: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-V2024Subscriptions -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-subscriptions + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_subscriptions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Delete a Subscription + + try { + Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#delete-subscription + source: | + 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 + + api_instance.delete_subscription(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_subscription(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#patch-subscription + source: | + 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') + [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + try: + # Patch a Subscription + Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) + api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) + print("The response of TriggersApi->patch_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $SubscriptionPutRequest = @" + { + "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 + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#update-subscription + source: | + 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 + Result = subscription_put_request.from_json(subscription_put_request) + api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) + print("The response of TriggersApi->update_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "triggerId eq "idn:access-request-dynamic-approver"" # 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-V2024TriggerInvocationStatus -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-trigger-invocation-status + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 "idn:access-request-post-approval"" # 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, ge, le* (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: **id, name** (optional) + + # List Triggers + + try { + Get-V2024Triggers -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-triggers + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_triggers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#start-test-trigger-invocation + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#start-test-trigger-invocation + source: | + x_sail_point_experimental = 'true' # 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 + Result = test_invocation.from_json(test_invocation) + api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/triggers#test-subscription-filter + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#test-subscription-filter + source: | + x_sail_point_experimental = 'true' # 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 + Result = validate_filter_input_dto.from_json(validate_filter_input_dto) + api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/ui-metadata#get-tenant-ui-metadata + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental) + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#set-tenant-ui-metadata + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/ui-metadata#set-tenant-ui-metadata + source: | + x_sail_point_experimental = 'true' # 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 + Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "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" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-V2024VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-V2024VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "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" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-V2024VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-V2024VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Approve an Approval Item + + try { + Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-V2024WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-V2024WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item + source: | + 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 + Result = work_item_forward.from_json(work_item_forward) + api_instance.forward_work_item(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.forward_work_item(id, x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + + # Completed Work Items + + try { + Get-V2024CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items + source: | + 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # Count Completed Work Items + + try { + Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-items + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-V2024CountWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items + source: | + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-V2024WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-V2024WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-V2024WorkItems + + # Below is a request that includes all optional parameters + # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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. + + # Reject an Approval Item + + try { + Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-V2024AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + x_sail_point_experimental = 'true' # 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Reassignment Configuration + + try { + Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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 + + api_instance.delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | 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) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-V2024EvaluateReassignmentConfiguration -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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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) + + 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 + + api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + + # Get Reassignment Configuration + + try { + Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration + source: | + 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 + + api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config + source: | + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-configuration + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration + source: | + x_sail_point_experimental = 'true' # 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 + Result = tenant_configuration_request.from_json(tenant_configuration_request) + api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = sailpoint.v2024.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.create_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.create_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + 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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.put_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_workflow(id, Result) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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 + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $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 = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -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 $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + 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 + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Filters = "id eq "sp:create-campaign"" # 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* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) + $Filters = "id eq "idn:identity-attributes-changed"" # 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* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.v2024.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {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}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml new file mode 100644 index 000000000..f9a81f9df --- /dev/null +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -0,0 +1,16106 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + 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 + + api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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 + + api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + 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 + + api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) +- path: /access-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + 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/v2024/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + 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/v2024/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + 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/v2024/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + 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/v2024/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + 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/v2024/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#update-access-profiles-in-bulk + source: | + x_sail_point_experimental = 'true' # 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=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + + try: + # Update Access Profile(s) requestable field. + Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#approve-access-request + source: | + 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 + + api_response = api_instance.approve_access_request(approval_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + 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/v2024/methods/access-request-approvals#forward-access-request + source: | + 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 + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + 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/v2024/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) +- path: /access-request-approvals/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-access-request-approvers + source: | + access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID. + 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) + 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) + try: + # Access Request Approvers + + api_response = api_instance.list_access_request_approvers(access_request_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_request_approvers(access_request_id, limit, offset, count) + print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-completed-approvals + source: | + 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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + 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/v2024/methods/access-request-approvals#list-pending-approvals + source: | + 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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + 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/v2024/methods/access-request-approvals#reject-access-request + source: | + 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 + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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 + + api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) +- path: /access-request-approvals/bulk-approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#approve-bulk-access-request + source: | + bulk_approve_access_request = { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } # BulkApproveAccessRequest | + try: + # Bulk Approve Access Request + Result = bulk_approve_access_request.from_json(bulk_approve_access_request) + api_response = api_instance.approve_bulk_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_bulk_access_request(Result) + print("The response of AccessRequestsApi->approve_bulk_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +- path: /access-requests/bulk-cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request-in-bulk + source: | + bulk_cancel_access_request = { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } # BulkCancelAccessRequest | + try: + # Bulk Cancel Access Request + Result = bulk_cancel_access_request.from_json(bulk_cancel_access_request) + api_response = api_instance.cancel_access_request_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request_in_bulk(Result) + print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) +- path: /access-requests/close + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#close-access-request + source: | + x_sail_point_experimental = 'true' # 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 + Result = close_access_request.from_json(close_access_request) + api_response = api_instance.close_access_request(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.close_access_request(x_sail_point_experimental, Result) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) +- path: /access-requests + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + 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/v2024/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + 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/v2024/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +- path: /access-request-administration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#list-administrators-access-request-status + source: | + 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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, accessRequestId** (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, accessRequestId** (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 for Administrators + + api_response = api_instance.list_administrators_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) + print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +- path: /access-request-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + 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/v2024/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + 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/v2024/methods/account-activities#list-account-activities + source: | + 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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-aggregations#get-account-aggregation-status + source: | + 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 + + api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + 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/v2024/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account-async + source: | + 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 + + api_response = api_instance.delete_account_async(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account_async(id, x_sail_point_experimental) + print("The response of AccountsApi->delete_account_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account-for-identity + source: | + 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 + + api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-accounts-for-identities + source: | + x_sail_point_experimental = 'true' # 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 + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account-for-identity + source: | + 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 + + api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-accounts-for-identities + source: | + x_sail_point_experimental = 'true' # 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 + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + 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/v2024/methods/accounts#get-account-entitlements + source: | + 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 + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + 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/v2024/methods/accounts#list-accounts + 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) + 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 + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + 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/v2024/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + 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/v2024/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + 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/v2024/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + 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/v2024/methods/accounts#update-account + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-discovered-applications + 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) + 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 + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + 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/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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/v2024/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/approvals#get-approval + source: | + 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 + + api_response = api_instance.get_approval(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approval(id, x_sail_point_experimental) + print("The response of ApprovalsApi->get_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) +- path: /generic-approvals + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/approvals#get-approvals + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_approvals(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approvals(x_sail_point_experimental, mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) +- path: /source-apps + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#create-source-app + source: | + x_sail_point_experimental = 'true' # 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 + Result = source_app_create_dto.from_json(source_app_create_dto) + api_response = api_instance.create_source_app(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_app(x_sail_point_experimental, Result) + print("The response of AppsApi->create_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + 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] | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#delete-source-app + source: | + 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 + + api_response = api_instance.delete_source_app(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->delete_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#get-source-app + source: | + 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 + + api_response = api_instance.get_source_app(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->get_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-access-profiles-for-source-app + source: | + 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 + + api_response = api_instance.list_access_profiles_for_source_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) +- path: /source-apps/all + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-all-source-app + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_all_source_app(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) +- path: /user-apps/all + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-all-user-apps + source: | + 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 + + api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-assigned-source-app + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-available-accounts-for-user-app + source: | + 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 + + api_response = api_instance.list_available_accounts_for_user_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) +- path: /source-apps + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-available-source-apps + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_available_source_apps(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) +- path: /user-apps + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-owned-user-apps + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#patch-source-app + source: | + 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') + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch source app by ID + + api_response = api_instance.patch_source_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_source_app(id, x_sail_point_experimental, Result) + print("The response of AppsApi->patch_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#patch-user-app + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch user app by ID + + api_response = api_instance.patch_user_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_user_app(id, x_sail_point_experimental, Result) + print("The response of AppsApi->patch_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#update-source-apps-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + + api_instance.update_source_apps_in_bulk(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.update_source_apps_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_profile_config(x_sail_point_experimental, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config(x_sail_point_experimental, id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) +- path: /auth-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config-list + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_profile_config_list(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config_list(x_sail_point_experimental) + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#patch-profile-config + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Auth Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-users#get-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + api_response = api_instance.get_auth_user(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(api_response) + 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/v2024/methods/auth-users#patch-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_user(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_user(id, Result) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(api_response) + 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/v2024/methods/branding#create-branding-item + source: | + 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 + + api_response = api_instance.create_branding_item(name, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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/v2024/methods/branding#delete-branding + source: | + 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 + + api_instance.delete_branding(name) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/branding#get-branding + source: | + 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 + + api_response = api_instance.get_branding(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(api_response) + 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/v2024/methods/branding#get-branding-list + source: | + try: + # List of branding items + + api_response = api_instance.get_branding_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(api_response) + 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/v2024/methods/branding#set-branding-item + source: | + 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 + + api_response = api_instance.set_branding_item(name, name2, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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/v2024/methods/certification-campaign-filters#create-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.create_campaign_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_filter(Result) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(api_response) + 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/v2024/methods/certification-campaign-filters#delete-campaign-filters + source: | + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + + try: + # Deletes Campaign Filters + Result = request_body.from_json(request_body) + api_instance.delete_campaign_filters(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_filters(Result) + 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/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + 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 + + api_response = api_instance.get_campaign_filter_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(api_response) + 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/v2024/methods/certification-campaign-filters#list-campaign-filters + 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) + 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 + + api_response = api_instance.list_campaign_filters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(api_response) + 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/v2024/methods/certification-campaign-filters#update-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.update_campaign_filter(filter_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign_filter(filter_id, Result) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#complete-campaign + source: | + 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 + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#create-campaign + source: | + 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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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 + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#create-campaign-template + source: | + 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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/certification-campaigns#delete-campaigns + source: | + campaigns_delete_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = campaigns_delete_request.from_json(campaigns_delete_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-campaign + source: | + 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 + + api_response = api_instance.get_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + 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/v2024/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#start-campaign-report + source: | + 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.v2024.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run. + try: + # Run Campaign Report + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + 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/v2024/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-certification-task + source: | + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + api_response = api_instance.get_certification_task(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(api_response) + 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/v2024/methods/certifications#get-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + api_response = api_instance.get_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(api_response) + 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/v2024/methods/certifications#get-identity-certification-item-permissions + source: | + 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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + 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/v2024/methods/certifications#get-pending-certification-tasks + source: | + 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 + + api_response = api_instance.get_pending_certification_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + pprint(api_response) + 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/v2024/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + 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/v2024/methods/certifications#list-identity-access-review-items + source: | + 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 + + api_response = api_instance.list_identity_access_review_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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/v2024/methods/certifications#list-identity-certifications + source: | + 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 + + api_response = api_instance.list_identity_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(api_response) + 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/v2024/methods/certifications#make-identity-decision + source: | + 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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + try: + # Decide on a Certification Item + Result = review_decision.from_json(review_decision) + api_response = api_instance.make_identity_decision(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.make_identity_decision(id, Result) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(api_response) + 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/v2024/methods/certifications#reassign-identity-certifications + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.reassign_identity_certifications(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reassign_identity_certifications(id, Result) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(api_response) + 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/v2024/methods/certifications#sign-off-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + api_response = api_instance.sign_off_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(api_response) + 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/v2024/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + 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 + + api_response = api_instance.get_identity_access_summaries(id, type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + pprint(api_response) + 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/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + 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 + + api_response = api_instance.get_identity_decision_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(api_response) + 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/v2024/methods/certification-summaries#get-identity-summaries + source: | + 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 + + api_response = api_instance.get_identity_summaries(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(api_response) + 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/v2024/methods/certification-summaries#get-identity-summary + source: | + 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 + + api_response = api_instance.get_identity_summary(id, identity_summary_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) +- path: /configuration-hub/deploys + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-deploy + source: | + deploy_request = { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } # DeployRequest | The deploy request body. + try: + # Create a Deploy + Result = deploy_request.from_json(deploy_request) + api_response = api_instance.create_deploy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_deploy(Result) + print("The response of ConfigurationHubApi->create_deploy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mapping + source: | + 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 + Result = object_mapping_request.from_json(object_mapping_request) + api_response = api_instance.create_object_mapping(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mapping(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(api_response) + 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/v2024/methods/configuration-hub#create-object-mappings + source: | + 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 + Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + api_response = api_instance.create_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + pprint(api_response) + 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/v2024/methods/configuration-hub#create-uploaded-configuration + source: | + 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 + + api_response = api_instance.create_uploaded_configuration(data, name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-backup + source: | + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete. + try: + # Delete a Backup + + api_instance.delete_backup(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_backup(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) +- path: /configuration-hub/drafts/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-draft + source: | + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete. + try: + # Delete a draft + + api_instance.delete_draft(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_draft(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-object-mapping + source: | + 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 + + api_instance.delete_object_mapping(source_org, object_mapping_id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/configuration-hub#delete-uploaded-configuration + source: | + 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 + + api_instance.delete_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_uploaded_configuration(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/deploys/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-deploy + source: | + id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy. + try: + # Get a Deploy + + api_response = api_instance.get_deploy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_deploy(id) + print("The response of ConfigurationHubApi->get_deploy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-object-mappings + source: | + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + api_response = api_instance.get_object_mappings(source_org) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(api_response) + 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/v2024/methods/configuration-hub#get-uploaded-configuration + source: | + 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 + + api_response = api_instance.get_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-backups + source: | + 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 Backups + + api_response = api_instance.list_backups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_backups(filters) + print("The response of ConfigurationHubApi->list_backups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) +- path: /configuration-hub/deploys + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-deploys + source: | + try: + # List Deploys + + api_response = api_instance.list_deploys() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_deploys() + print("The response of ConfigurationHubApi->list_deploys:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) +- path: /configuration-hub/drafts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-drafts + source: | + 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* **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: **status**: *eq* **approvalStatus**: *eq* (optional) + try: + # List Drafts + + api_response = api_instance.list_drafts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_drafts(filters) + print("The response of ConfigurationHubApi->list_drafts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-uploaded-configurations + source: | + 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 + + api_response = api_instance.list_uploaded_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(api_response) + 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/v2024/methods/configuration-hub#update-object-mappings + source: | + 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 + Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + api_response = api_instance.update_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) +- path: /connector-rules + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#create-connector-rule + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | Connector rule to create. + try: + # Create Connector Rule + Result = connector_rule_create_request.from_json(connector_rule_create_request) + api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#delete-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule 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 Connector Rule + + api_instance.delete_connector_rule(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_connector_rule(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule 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 Connector Rule + + api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) +- path: /connector-rules + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule-list + source: | + x_sail_point_experimental = 'true' # 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: + # List Connector Rules + + api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, limit, offset, count) + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#put-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + try: + # Update Connector Rule + + api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#test-connector-rule + source: | + x_sail_point_experimental = 'true' # 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_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | Code to validate. + try: + # Validate Connector Rule + Result = source_code.from_json(source_code) + api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) +- path: /connectors + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#create-custom-connector + source: | + v3_create_connector_dto = { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } # V3CreateConnectorDto | + try: + # Create Custom Connector + Result = v3_create_connector_dto.from_json(v3_create_connector_dto) + api_response = api_instance.create_custom_connector(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_connector(Result) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(api_response) + 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/v2024/methods/connectors#delete-custom-connector + source: | + 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 + + api_instance.delete_custom_connector(script_name) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/connectors#get-connector + source: | + 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 + + api_response = api_instance.get_connector(script_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) +- path: /connectors/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-correlation-config + source: | + 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 Correlation Configuration + + api_response = api_instance.get_connector_correlation_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_correlation_config(script_name) + print("The response of ConnectorsApi->get_connector_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) +- path: /connectors + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-list + source: | + 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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + 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/v2024/methods/connectors#get-connector-source-config + source: | + 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 + + api_response = api_instance.get_connector_source_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(api_response) + 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/v2024/methods/connectors#get-connector-source-template + source: | + 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 + + api_response = api_instance.get_connector_source_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(api_response) + 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/v2024/methods/connectors#get-connector-translations + source: | + 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 + + api_response = api_instance.get_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) +- path: /connectors/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-correlation-config + source: | + 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 correlation config xml file # bytearray | connector correlation config xml file + try: + # Update Connector Correlation Configuration + + api_response = api_instance.put_connector_correlation_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_correlation_config(script_name, file) + print("The response of ConnectorsApi->put_connector_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-config + source: | + 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 + + api_response = api_instance.put_connector_source_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(api_response) + 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/v2024/methods/connectors#put-connector-source-template + source: | + 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 + + api_response = api_instance.put_connector_source_template(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(api_response) + 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/v2024/methods/connectors#put-connector-translations + source: | + 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 + + api_response = api_instance.put_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(api_response) + 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/v2024/methods/connectors#update-connector + source: | + 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. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + try: + # Update Connector by Script Name + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_connector(script_name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector(script_name, Result) + print("The response of ConnectorsApi->update_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) +- path: /form-definitions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_definition(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-dynamic-schema + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-file-request + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID + x_sail_point_experimental = 'true' # 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 | File specifying the multipart # bytearray | File specifying the multipart + try: + # Upload new form definition file. + + api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) +- path: /form-instances + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-instance + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_instance(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_instance(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#delete-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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: + # Deletes a form definition. + + api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#export-form-definitions-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 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. + + api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-file-from-s3 + source: | + 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. + x_sail_point_experimental = 'true' # 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: + # Download definition file by fileId. + + api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-definition-by-key + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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: + # Return a form definition. + + api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-by-key + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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 a form instance. + + api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-file + source: | + 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. + x_sail_point_experimental = 'true' # 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: + # Download instance file by fileId. + + api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#import-form-definitions + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + 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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + + try: + # Import form definitions from export. + + api_response = api_instance.import_form_definitions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_form_definitions(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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') + 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) + 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. + + api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, Result) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-instance + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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') + 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) + 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. + + api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, Result) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) +- path: /form-definitions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-definitions-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 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. + + api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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 + x_sail_point_experimental = 'true' # 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 | 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. + + api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, limit, filters, query) + print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) +- path: /form-instances + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-instances-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 form instances by tenant. + + api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental) + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-pre-defined-select-options + source: | + x_sail_point_experimental = 'true' # 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 predefined select options. + + api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental) + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#show-preview-data-source + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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 = 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. + + api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, limit, filters, query, Result) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#create-custom-password-instructions + source: | + x_sail_point_experimental = 'true' # 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 + Result = custom_password_instruction.from_json(custom_password_instruction) + api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#delete-custom-password-instructions + source: | + 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 + + api_instance.delete_custom_password_instructions(page_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#get-custom-password-instructions + source: | + 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 + + api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) +- path: /data-segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#create-data-segment + source: | + data_segment = sailpoint.v2024.DataSegment() # DataSegment | + try: + # Create Segment + Result = data_segment.from_json(data_segment) + api_response = api_instance.create_data_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_data_segment(Result) + print("The response of DataSegmentationApi->create_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) +- path: /data-segments/{segmentId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#delete-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID 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') + published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False) + try: + # Delete Segment by ID + + api_instance.delete_data_segment(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_data_segment(id, x_sail_point_experimental, published) + except Exception as e: + print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) +- path: /data-segments/{segmentId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + x_sail_point_experimental = 'true' # 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 Segment by ID + + api_response = api_instance.get_data_segment(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segment(id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) +- path: /data-segments/membership/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment-identity-membership + source: | + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. + x_sail_point_experimental = 'true' # 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 SegmentMembership by Identity ID + + api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) +- path: /data-segments/user-enabled/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. + x_sail_point_experimental = 'true' # 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: + # Is Segmentation enabled by Identity + + api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) +- path: /data-segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#list-data-segments + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) + unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) + published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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 = 'name 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, in, sw* **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, sw* **name**: *eq, in, sw* (optional) + try: + # Get Segments + + api_response = api_instance.list_data_segments(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) + print("The response of DataSegmentationApi->list_data_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) +- path: /data-segments/{segmentId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#patch-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + x_sail_point_experimental = 'true' # 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 = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + request_body = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + + try: + # Update Segment + Result = request_body.from_json(request_body) + api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) + print("The response of DataSegmentationApi->patch_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) +- path: /data-segments/{segmentId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#publish-data-segment + source: | + x_sail_point_experimental = 'true' # 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] | A list of segment ids that you wish to publish + request_body = ['request_body_example'] # List[str] | A list of segment ids that you wish to publish + + publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) + try: + # Publish segment by ID + Result = request_body.from_json(request_body) + api_instance.publish_data_segment(x_sail_point_experimental, Result, ) + + # Below is a request that includes all optional parameters + # api_instance.publish_data_segment(x_sail_point_experimental, Result, publish_all) + except Exception as e: + print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) +- path: /roles/{roleId}/dimensions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#create-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension = { + "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" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "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.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } # Dimension | + try: + # Create a Dimension + Result = dimension.from_json(dimension) + api_response = api_instance.create_dimension(role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_dimension(role_id, Result) + print("The response of DimensionsApi->create_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-bulk-dimensions + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. + dimension_bulk_delete_request = { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # DimensionBulkDeleteRequest | + try: + # Delete Dimension(s) + Result = dimension_bulk_delete_request.from_json(dimension_bulk_delete_request) + api_response = api_instance.delete_bulk_dimensions(role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_dimensions(role_id, Result) + print("The response of DimensionsApi->delete_bulk_dimensions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + try: + # Delete a Dimension + + api_instance.delete_dimension(role_id, dimension_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_dimension(role_id, dimension_id) + except Exception as e: + print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + try: + # Get a Dimension under Role. + + api_response = api_instance.get_dimension(role_id, dimension_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dimension(role_id, dimension_id) + print("The response of DimensionsApi->get_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension-entitlements + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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* (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 Dimension's Entitlements + + api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->get_dimension_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimension-access-profiles + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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 = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # 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* **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* **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, 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 Dimension's Access Profiles + + api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimension_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) +- path: /roles/{roleId}/dimensions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimensions + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + 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 = 'id eq \'2c918086749d78830174a1a40e121518\'' # 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* (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* (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) + try: + # List Dimensions + + api_response = api_instance.list_dimensions(role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimensions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) +- path: /roles/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#patch-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + [{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Dimension + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_dimension(role_id, dimension_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_dimension(role_id, dimension_id, Result) + print("The response of DimensionsApi->patch_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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. + + api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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. + + api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement + source: | + 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 + + api_response = api_instance.get_entitlement(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement-request-config + source: | + 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 + + api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#import-entitlements-by-source + source: | + 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 + + api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-children + source: | + 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 + + api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-parents + source: | + 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 + + api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) +- path: /entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlements + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.list_entitlements(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#patch-entitlement + source: | + 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') + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch an entitlement + + api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, Result) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#put-entitlement-request-config + source: | + 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 + Result = entitlement_request_config.from_json(entitlement_request_config) + api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#reset-source-entitlements + source: | + 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 + + api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#update-entitlements-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + 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. + Result = network_configuration.from_json(network_configuration) + api_response = api_instance.create_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + try: + # Get security network configuration. + + api_response = api_instance.get_auth_org_network_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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. + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /workgroups + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#create-workgroup + source: | + x_sail_point_experimental = 'true' # 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. + Result = workgroup_dto.from_json(workgroup_dto) + api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup + source: | + 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 + + api_instance.delete_workgroup(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_workgroup(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup-members + source: | + 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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + + try: + # Remove members from Governance Group + Result = identity_preview_response_identity.from_json(identity_preview_response_identity) + api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroups-in-bulk + source: | + x_sail_point_experimental = 'true' # 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) + Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#get-workgroup + source: | + 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 + + api_response = api_instance.get_workgroup(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workgroup(id, x_sail_point_experimental) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-connections + source: | + 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 + + api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroup-members + source: | + 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 + + api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) +- path: /workgroups + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroups + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_workgroups(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#patch-workgroup + source: | + 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') + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch a Governance Group + + api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#update-workgroup-members + source: | + 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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + + try: + # Add members to Governance Group + Result = identity_preview_response_identity.from_json(identity_preview_response_identity) + api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Ignored Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Requested Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Viewed Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + try: + # Notification of Viewed Access Request Recommendations in Bulk + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 + + api_response = api_instance.get_access_request_recommendations(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) +- path: /ai-access-request-recommendations/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + x_sail_point_experimental = 'true' # 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 of Ignored Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_ignored_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 of Requested Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_requested_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 of Viewed Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_viewed_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) +- path: /ai-access-request-recommendations/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = access_request_recommendation_config_dto.from_json(access_request_recommendation_config_dto) + api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) +- path: /common-access + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#create-common-access + source: | + x_sail_point_experimental = 'true' # 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 + Result = common_access_item_request.from_json(common_access_item_request) + api_response = api_instance.create_common_access(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_common_access(x_sail_point_experimental, Result) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) +- path: /common-access + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#get-common-access + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_common_access(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#update-common-access-status-in-bulk + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + try: + # Bulk update common access status + Result = common_access_id_status.from_json(common_access_id_status) + api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) +- path: /outliers/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#export-outliers-zip + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.export_outliers_zip(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_outliers_zip(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outlier-snapshots + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) +- path: /outliers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_identity_outliers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + 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 + + api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + 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 + + api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#ignore-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Ignore + Result = request_body.from_json(request_body) + api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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 + + api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#un-ignore-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Unignore + Result = request_body.from_json(request_body) + api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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 + + api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) +- path: /recommendations/request + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations + source: | + x_sail_point_experimental = 'true' # 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 a Recommendation Based on Object + Result = recommendation_request_dto.from_json(recommendation_request_dto) + api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) +- path: /recommendations/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_recommendations_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations_config(x_sail_point_experimental) + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#update-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = recommendation_config_dto.from_json(recommendation_config_dto) + api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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. + + api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, Result) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-role-mining-sessions + source: | + x_sail_point_experimental = 'true' # 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 + Result = role_mining_session_dto.from_json(role_mining_session_dto) + api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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 + + api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-all-potential-role-summaries + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_all_potential_role_summaries(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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 + + api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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 + + api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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 + + api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-identities-potential-role + source: | + 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 + + api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role + source: | + 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 + + api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-applications + source: | + 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 + + api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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 + + api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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 + + api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-summaries + source: | + 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 + + api_response = api_instance.get_potential_role_summaries(session_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-potential-role + source: | + 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 + + api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session + source: | + 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 + + api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session-status + source: | + 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 + + api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-sessions + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-saved-potential-roles + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role + source: | + 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') + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role-0 + source: | + 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') + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-role-mining-session + source: | + 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') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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 + Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/icons#delete-icon + source: | + 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 + + api_instance.delete_icon(object_type, object_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_icon(object_type, object_id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/icons#set-icon + source: | + 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 + + api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image) + print("The response of IconsApi->set_icon:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#delete-identity + source: | + 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 + + api_instance.delete_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) +- path: /identities/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-identity + source: | + 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 + + api_response = api_instance.get_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity(id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-identity-ownership-details + source: | + 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 + + api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignment + source: | + 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 + + api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignments + source: | + 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 + + api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) +- path: /identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#list-identities + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#reset-identity + source: | + 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 + + api_instance.reset_identity(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.reset_identity(identity_id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#send-identity-verification-account-token + source: | + x_sail_point_experimental = 'true' # 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 + Result = send_account_verification_request.from_json(send_account_verification_request) + api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) +- path: /identities/invite + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#start-identities-invite + source: | + x_sail_point_experimental = 'true' # 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 + Result = invite_identities_request.from_json(invite_identities_request) + api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) +- path: /identities/process + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#start-identity-processing + source: | + x_sail_point_experimental = 'true' # 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 + Result = process_identities_request.from_json(process_identities_request) + api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#synchronize-attributes-for-identity + source: | + 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. + + api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) +- path: /identity-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#create-identity-attribute + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attribute + source: | + 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 + + api_instance.delete_identity_attribute(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attribute(name, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_attribute_names.from_json(identity_attribute_names) + api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#get-identity-attribute + source: | + 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 + + api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) +- path: /identity-attributes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#list-identity-attributes + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_identity_attributes(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#put-identity-attribute + source: | + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots + source: | + 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) + + 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 + + api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 + + api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity + source: | + 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 + + api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity-events + source: | + 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) + + 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) + + 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 + + api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot + source: | + 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 + + api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot-summary + source: | + 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 + + api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-start-date + source: | + 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 + + api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) +- path: /historical-identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-historical-identities + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_historical_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-access-items + source: | + 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 + + api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshot-access-items + source: | + 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 + + api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshots + source: | + 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 + + api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) +- path: /identity-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#create-identity-profile + source: | + 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 + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#export-identity-profiles + 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) + 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#generate-identity-preview + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) + print("The response of IdentityProfilesApi->generate_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.v2024.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#list-identity-profiles + 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) + 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + 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/v2024/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + 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/v2024/methods/lifecycle-states#create-lifecycle-state + source: | + 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 + Result = lifecycle_state.from_json(lifecycle_state) + api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(api_response) + 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/v2024/methods/lifecycle-states#delete-lifecycle-state + source: | + 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 + + api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(api_response) + 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/v2024/methods/lifecycle-states#get-lifecycle-state + source: | + 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 + + api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(api_response) + 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/v2024/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + 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/v2024/methods/lifecycle-states#set-lifecycle-state + source: | + identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update. + set_lifecycle_state_request = sailpoint.v2024.SetLifecycleStateRequest() # SetLifecycleStateRequest | + try: + # Set Lifecycle State + Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request) + api_response = api_instance.set_lifecycle_state(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_lifecycle_state(identity_id, Result) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(api_response) + 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/v2024/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /machine-accounts/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#get-machine-account + source: | + 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 + + api_response = api_instance.get_machine_account(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_machine_account(id, x_sail_point_experimental) + print("The response of MachineAccountsApi->get_machine_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) +- path: /machine-accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#list-machine-accounts + source: | + x_sail_point_experimental = 'true' # 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* **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) # 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* **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) + 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 + + api_response = api_instance.list_machine_accounts(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of MachineAccountsApi->list_machine_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) +- path: /machine-accounts/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#update-machine-account + source: | + 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. + 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. + + try: + # Update a Machine Account + Result = request_body.from_json(request_body) + api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) + print("The response of MachineAccountsApi->update_machine_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) +- path: /machine-identities + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#create-machine-identity + source: | + x_sail_point_experimental = 'true' # 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 + Result = machine_identity.from_json(machine_identity) + api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) + print("The response of MachineIdentitiesApi->create_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) +- path: /machine-identities/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#delete-machine-identity + source: | + 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 + + api_instance.delete_machine_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_machine_identity(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) +- path: /machine-identities/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#get-machine-identity + source: | + 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 + + api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) + print("The response of MachineIdentitiesApi->get_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) +- path: /machine-identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#list-machine-identities + source: | + x_sail_point_experimental = 'true' # 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 = '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 + + api_response = api_instance.list_machine_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset) + print("The response of MachineIdentitiesApi->list_machine_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) +- path: /machine-identities/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#update-machine-identity + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) + print("The response of MachineIdentitiesApi->update_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#create-managed-client + source: | + managed_client_request = { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } # ManagedClientRequest | + try: + # Create Managed Client + Result = managed_client_request.from_json(managed_client_request) + api_response = api_instance.create_managed_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_client(Result) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(api_response) + 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/v2024/methods/managed-clients#delete-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + api_instance.delete_managed_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/managed-clients#get-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + api_response = api_instance.get_managed_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(api_response) + 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/v2024/methods/managed-clients#get-managed-client-status + source: | + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v2024.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + 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/v2024/methods/managed-clients#get-managed-clients + source: | + 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 + + api_response = api_instance.get_managed_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(api_response) + 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/v2024/methods/managed-clients#update-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Client + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client(id, Result) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(api_response) + 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/v2024/methods/managed-clusters#create-managed-cluster + source: | + 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 + Result = managed_cluster_request.from_json(managed_cluster_request) + api_response = api_instance.create_managed_cluster(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_cluster(Result) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(api_response) + 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/v2024/methods/managed-clusters#delete-managed-cluster + source: | + 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 + + api_instance.delete_managed_cluster(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/managed-clusters#get-client-log-configuration + source: | + 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 + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + 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/v2024/methods/managed-clusters#get-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + 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/v2024/methods/managed-clusters#get-managed-clusters + source: | + 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 + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + 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/v2024/methods/managed-clusters#put-client-log-configuration + source: | + 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.v2024.PutClientLogConfigurationRequest() # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request) + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + 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/v2024/methods/managed-clusters#update-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Cluster + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_cluster(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_cluster(id, Result) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + 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/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + 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/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + 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/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + 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/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + 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/v2024/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + 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/v2024/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + 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 + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + 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 + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + delete_non_employee_records_in_bulk_request = sailpoint.v2024.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + api_instance.delete_non_employee_records_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_records_in_bulk(Result) + 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/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + 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 + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + 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 + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + 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 + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + 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 + + api_response = api_instance.list_non_employee_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + 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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + 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 + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + 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/v2024/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +- path: /verified-domains + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-domain-dkim + source: | + x_sail_point_experimental = 'true' # 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 + Result = domain_address.from_json(domain_address) + api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) +- path: /notification-templates + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-notification-template + source: | + x_sail_point_experimental = 'true' # 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 + Result = template_dto.from_json(template_dto) + api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-verified-from-address + source: | + x_sail_point_experimental = 'true' # 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 + Result = email_status_dto.from_json(email_status_dto) + api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#delete-notification-templates-in-bulk + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) + api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#delete-verified-from-address + source: | + 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 + + api_instance.delete_verified_from_address(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /verified-domains + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-dkim-attributes + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_dkim_attributes(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dkim_attributes(x_sail_point_experimental) + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-mail-from-attributes + source: | + 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 + + api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-notification-template + source: | + 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 + + api_response = api_instance.get_notification_template(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notification_template(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) +- path: /notification-template-context + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-notifications-template-context + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_notifications_template_context(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notifications_template_context(x_sail_point_experimental) + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-from-addresses + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_from_addresses(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-preferences + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.list_notification_preferences(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_preferences(x_sail_point_experimental) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-template-defaults + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) +- path: /notification-templates + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-templates + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_notification_templates(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_templates(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#put-mail-from-attributes + source: | + x_sail_point_experimental = 'true' # 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 + Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) + api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) +- path: /send-test-notification + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#send-test-notification + source: | + x_sail_point_experimental = 'true' # 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 + Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) + api_instance.send_test_notification(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_test_notification(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) +- path: /oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#create-oauth-client + source: | + 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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + 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/v2024/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + 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/v2024/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + 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/v2024/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +- path: /org-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#get-org-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_org_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_org_config(x_sail_point_experimental) + print("The response of OrgConfigApi->get_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#get-valid-time-zones + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, limit, offset, count) + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) +- path: /org-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#patch-org-config + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) +- path: /password-org-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + 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/v2024/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + 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/v2024/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + 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/v2024/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + 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/v2024/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#create-digit-token + source: | + x_sail_point_experimental = 'true' # 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 + Result = password_digit_token_reset.from_json(password_digit_token_reset) + api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#get-password-change-status + source: | + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + api_response = api_instance.get_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(api_response) + 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/v2024/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + 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/v2024/methods/password-management#set-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password(Result) + print("The response of PasswordManagementApi->set_password:\n") + pprint(api_response) + 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/v2024/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + 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/v2024/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + 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/v2024/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + 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/v2024/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + 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/v2024/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + 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/v2024/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + 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/v2024/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + 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/v2024/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + 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/v2024/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + 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/v2024/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + 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/v2024/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + 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/v2024/methods/public-identities#get-public-identities + 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) + 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 + + api_response = api_instance.get_public_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + pprint(api_response) + 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/v2024/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get the Public Identities Configuration + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + 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/v2024/methods/public-identities-config#update-public-identity-config + source: | + 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 + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + 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/v2024/methods/reports-data-extraction#cancel-report + source: | + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + api_instance.cancel_report(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/reports-data-extraction#get-report + source: | + 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 + + api_response = api_instance.get_report(task_result_id, file_format, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(api_response) + 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/v2024/methods/reports-data-extraction#get-report-result + source: | + 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 + + api_response = api_instance.get_report_result(task_result_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(api_response) + 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/v2024/methods/reports-data-extraction#start-report + source: | + report_details = { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } # ReportDetails | + try: + # Run Report + Result = report_details.from_json(report_details) + api_response = api_instance.start_report(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_report(Result) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(api_response) + 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/v2024/methods/requestable-objects#list-requestable-objects + source: | + 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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#create-role-insight-requests + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.create_role_insight_requests(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_insight_requests(x_sail_point_experimental) + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#download-role-insights-entitlements-changes + source: | + 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 + + api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-entitlement-changes-identities + source: | + 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) + + api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insight + source: | + 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 + + api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) +- path: /role-insights + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_insights(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-current-entitlements + source: | + 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 + + api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-entitlements-changes + source: | + 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 + + api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-requests + source: | + 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. + + api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-summary + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_insights_summary(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_summary(x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) +- path: /roles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + 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/v2024/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + 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. + + api_instance.delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status + source: | + try: + # Get Bulk-Update Statuses + + api_response = api_instance.get_bulk_update_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_bulk_update_status() + print("The response of RolesApi->get_bulk_update_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status-by-id + source: | + 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 + + api_response = api_instance.get_bulk_update_status_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_bulk_update_status_by_id(id) + print("The response of RolesApi->get_bulk_update_status_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) +- path: /roles/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + 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/v2024/methods/roles#get-role-assigned-identities + source: | + 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 + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role-entitlements + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing 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') + 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* (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 + + api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) +- path: /roles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + 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/v2024/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /roles/filter + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#search-roles-by-filter + source: | + 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 + + api_response = api_instance.search_roles_by_filter() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, Result) + print("The response of RolesApi->search_roles_by_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-attribute-key-and-value-to-role + source: | + 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. + + api_response = api_instance.update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-filter + source: | + 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 + Result = role_metadata_bulk_update_by_filter_request.from_json(role_metadata_bulk_update_by_filter_request) + api_response = api_instance.update_roles_metadata_by_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_filter(Result) + print("The response of RolesApi->update_roles_metadata_by_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-ids + source: | + 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 + Result = role_metadata_bulk_update_by_id_request.from_json(role_metadata_bulk_update_by_id_request) + api_response = api_instance.update_roles_metadata_by_ids(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_ids(Result) + print("The response of RolesApi->update_roles_metadata_by_ids:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) +- path: /roles/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-query + source: | + 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 + Result = role_metadata_bulk_update_by_query_request.from_json(role_metadata_bulk_update_by_query_request) + api_response = api_instance.update_roles_metadata_by_query(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_query(Result) + print("The response of RolesApi->update_roles_metadata_by_query:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +- path: /saved-searches + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#create-saved-search + source: | + create_saved_search_request = sailpoint.v2024.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + Result = create_saved_search_request.from_json(create_saved_search_request) + api_response = api_instance.create_saved_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_saved_search(Result) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(api_response) + 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/v2024/methods/saved-search#delete-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + api_instance.delete_saved_search(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/saved-search#execute-saved-search + source: | + 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 + Result = search_arguments.from_json(search_arguments) + api_instance.execute_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.execute_saved_search(id, Result) + 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/v2024/methods/saved-search#get-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + api_response = api_instance.get_saved_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(api_response) + 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/v2024/methods/saved-search#list-saved-searches + source: | + 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 + + api_response = api_instance.list_saved_searches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(api_response) + 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/v2024/methods/saved-search#put-saved-search + source: | + 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 + Result = saved_search.from_json(saved_search) + api_response = api_instance.put_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_saved_search(id, Result) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(api_response) + 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/v2024/methods/scheduled-search#create-scheduled-search + source: | + 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 + Result = create_scheduled_search_request.from_json(create_scheduled_search_request) + api_response = api_instance.create_scheduled_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_scheduled_search(Result) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(api_response) + 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/v2024/methods/scheduled-search#delete-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + api_instance.delete_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/scheduled-search#get-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + api_response = api_instance.get_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(api_response) + 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/v2024/methods/scheduled-search#list-scheduled-search + source: | + 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 + + api_response = api_instance.list_scheduled_search() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(api_response) + 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/v2024/methods/scheduled-search#unsubscribe-scheduled-search + source: | + 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 + Result = typed_reference.from_json(typed_reference) + api_instance.unsubscribe_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.unsubscribe_scheduled_search(id, Result) + 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/v2024/methods/scheduled-search#update-scheduled-search + source: | + 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 + Result = scheduled_search.from_json(scheduled_search) + api_response = api_instance.update_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_scheduled_search(id, Result) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(api_response) + 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/v2024/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_aggregate(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_aggregate(Result, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(api_response) + 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/v2024/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" + } + } + } # Search | + try: + # Count Documents Satisfying a Query + Result = search.from_json(search) + api_instance.search_count(Result) + + # Below is a request that includes all optional parameters + # api_instance.search_count(Result) + 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/v2024/methods/search#search-get + source: | + 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 + + api_response = api_instance.search_get(index, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(api_response) + 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/v2024/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_post(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_post(Result, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(api_response) + 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/v2024/methods/search-attribute-configuration#create-search-attribute-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + 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/v2024/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-search-attribute-config + source: | + x_sail_point_experimental = 'true' # 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 Extended Search Attributes + + api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + 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/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + 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 + + api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + 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/v2024/methods/search-attribute-configuration#patch-search-attribute-config + source: | + 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') + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + 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/v2024/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + 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/v2024/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + 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/v2024/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + 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/v2024/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + 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/v2024/methods/service-desk-integration#create-service-desk-integration + source: | + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integrations + source: | + 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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v2024.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /sim-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration + source: | + x_sail_point_experimental = 'true' # 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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + 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 + + api_instance.delete_sim_integration(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + 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. + + api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +- path: /sim-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.get_sim_integrations(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + 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. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + 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. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + 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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#delete-sod-policy + source: | + 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 + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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/v2024/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#get-sod-policy + source: | + 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 + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + 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 + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#patch-sod-policy + source: | + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#put-policy-schedule + source: | + 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 + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#put-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + 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 + + api_response = api_instance.start_evaluate_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + 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 + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + 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/v2024/methods/sod-policies#start-sod-policy + source: | + 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 + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + 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/v2024/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + 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/v2024/methods/sod-violations#start-violation-check + source: | + 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 + Result = identity_with_new_access1.from_json(identity_with_new_access1) + api_response = api_instance.start_violation_check(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_violation_check(Result) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +- path: /sources + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +- path: /sources/{sourceId}/schedules + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schedule + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + schedule1 = sailpoint.v2024.Schedule1() # Schedule1 | + try: + # Create Schedule on Source + Result = schedule1.from_json(schedule1) + api_response = api_instance.create_source_schedule(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schedule(source_id, Result) + print("The response of SourcesApi->create_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.v2024.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-accounts-async + source: | + 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 + + api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-native-change-detection-config + source: | + 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 + + api_instance.delete_native_change_detection_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) +- path: /sources/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schedule + source: | + 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. + + api_instance.delete_source_schedule(source_id, schedule_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schedule(source_id, schedule_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_accounts_schema(id) + + # Below is a request that includes all optional parameters + # api_instance.get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-correlation-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + api_response = api_instance.get_correlation_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_correlation_config(id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-entitlements-schema + source: | + 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 + + api_instance.get_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-native-change-detection-config + source: | + 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 + + api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-attr-sync-config + source: | + 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 + + api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-config + source: | + 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') + locale = 'locale_example' # 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 + + api_response = api_instance.get_source_config(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_config(id, x_sail_point_experimental, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-entitlement-request-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-health + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + api_response = api_instance.get_source_health(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) +- path: /sources/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedule + source: | + 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 + + api_response = api_instance.get_source_schedule(source_id, schedule_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schedule(source_id, schedule_type) + print("The response of SourcesApi->get_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schedules + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedules + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # List Schedules on Source + + api_response = api_instance.get_source_schedules(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schedules(source_id) + print("The response of SourcesApi->get_source_schedules:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts + source: | + 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 + + api_response = api_instance.import_accounts(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts(id, x_sail_point_experimental, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_accounts_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-connector-file + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-entitlements-schema + source: | + 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 + + api_response = api_instance.import_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-uncorrelated-accounts + source: | + 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 + + api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +- path: /sources + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#list-sources + 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) + 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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#peek-resource-objects + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + resource_objects_request = { + "maxCount" : 100, + "objectType" : "group" + } # ResourceObjectsRequest | + try: + # Peek source connector's resource objects + Result = resource_objects_request.from_json(resource_objects_request) + api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#ping-cluster + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # 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: + # Ping cluster for source connector + + api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + print("The response of SourcesApi->ping_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-correlation-config + source: | + 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 + Result = correlation_config.from_json(correlation_config) + api_response = api_instance.put_correlation_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_correlation_config(id, Result) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-native-change-detection-config + source: | + 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 + Result = native_change_detection_config.from_json(native_change_detection_config) + api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source-attr-sync-config + source: | + 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 + Result = attr_sync_source_config.from_json(attr_sync_source_config) + api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source-schema + source: | + 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.v2024.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#sync-attributes-for-source + source: | + 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. + + api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#test-source-configuration + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # 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: + # Test configuration for source connector + + api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#test-source-connection + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + x_sail_point_experimental = 'true' # 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: + # Check connection for source connector. + + api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_connection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) +- path: /sources/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-password-policy-holders + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + password_policy_holders_dto_inner = [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + + try: + # Update Password Policy + Result = password_policy_holders_dto_inner.from_json(password_policy_holders_dto_inner) + api_response = api_instance.update_password_policy_holders(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_policy_holders(source_id, Result) + print("The response of SourcesApi->update_password_policy_holders:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v2024.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v2024.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-entitlement-request-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = source_entitlement_request_config.from_json(source_entitlement_request_config) + api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schedule + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. + [{op=replace, path=/cronExpression, value=0 0 6 * * ?}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + + try: + # Update Source Schedule (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + print("The response of SourcesApi->update_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sp-config/export + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + export_payload = { + "description" : "Export Job 1 Test" + } # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + Result = export_payload.from_json(export_payload) + api_response = api_instance.export_sp_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_sp_config(Result) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + 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. + + api_response = api_instance.get_sp_config_export(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + 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 + + api_response = api_instance.get_sp_config_export_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + 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 + + api_response = api_instance.get_sp_config_import(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + 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 + + api_response = api_instance.get_sp_config_import_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +- path: /sp-config/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + 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 + + api_response = api_instance.import_sp_config(data, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + try: + # Get config object details + + api_response = api_instance.list_sp_config_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + api_response = api_instance.get_sed_batch_stats(batch_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batches + source: | + try: + # List Sed Batch Request + + api_response = api_instance.get_sed_batches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#list-seds + 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) + 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 + + api_response = api_instance.list_seds() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#patch-sed + source: | + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + [sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + try: + # Patch Suggested Entitlement Description + Result = sed_patch.from_json(sed_patch) + api_response = api_instance.patch_sed(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sed(id, Result) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-approval + source: | + [sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + try: + # Submit Bulk Approval Request + Result = sed_approval.from_json(sed_approval) + api_response = api_instance.submit_sed_approval(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_approval(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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 + Result = sed_assignment.from_json(sed_assignment) + api_response = api_instance.submit_sed_assignment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_assignment(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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 + + api_response = api_instance.submit_sed_batch_request() + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_batch_request(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tags-to-many-object + source: | + 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 + Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +- path: /tagged-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +- path: /tagged-objects + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tags-to-many-objects + source: | + 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 + Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-task-headers + source: | + x_sail_point_experimental = 'true' # 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 + + api_instance.get_pending_task_headers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-tasks + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_pending_tasks(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_tasks(x_sail_point_experimental, offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status + source: | + 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 + + api_response = api_instance.get_task_status(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status(id, x_sail_point_experimental) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) +- path: /task-status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status-list + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_task_status_list(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#update-task-status + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + try: + # Update Task Status by ID + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) +- path: /tenant + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tenant#get-tenant + source: | + try: + # Get Tenant Information. + + api_response = api_instance.get_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) +- path: /transforms + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +- path: /transforms + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#complete-trigger-invocation + source: | + 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 + Result = complete_invocation.from_json(complete_invocation) + api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#create-subscription + source: | + x_sail_point_experimental = 'true' # 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 + Result = subscription_post_request.from_json(subscription_post_request) + api_response = api_instance.create_subscription(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_subscription(x_sail_point_experimental, Result) + print("The response of TriggersApi->create_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#delete-subscription + source: | + 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 + + api_instance.delete_subscription(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_subscription(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-subscriptions + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_subscriptions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-trigger-invocation-status + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) +- path: /triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-triggers + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_triggers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#patch-subscription + source: | + 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') + [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + try: + # Patch a Subscription + Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) + api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) + print("The response of TriggersApi->patch_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#start-test-trigger-invocation + source: | + x_sail_point_experimental = 'true' # 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 + Result = test_invocation.from_json(test_invocation) + api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#test-subscription-filter + source: | + x_sail_point_experimental = 'true' # 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 + Result = validate_filter_input_dto.from_json(validate_filter_input_dto) + api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#update-subscription + source: | + 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 + Result = subscription_put_request.from_json(subscription_put_request) + api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) + print("The response of TriggersApi->update_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/ui-metadata#get-tenant-ui-metadata + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental) + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/ui-metadata#set-tenant-ui-metadata + source: | + x_sail_point_experimental = 'true' # 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 + Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = sailpoint.v2024.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.create_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.create_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + 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 + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + 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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.put_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_workflow(id, Result) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.v2024.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item + source: | + 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 + Result = work_item_forward.from_json(work_item_forward) + api_instance.forward_work_item(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.forward_work_item(id, x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items + source: | + 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-items + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items + source: | + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + x_sail_point_experimental = 'true' # 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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 + + api_instance.delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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) +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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) + + 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 + + api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration + source: | + 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 + + api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-configuration + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config + source: | + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration + source: | + x_sail_point_experimental = 'true' # 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 + Result = tenant_configuration_request.from_json(tenant_configuration_request) + api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) diff --git a/static/code-examples/v2024/v2024.yaml b/static/code-examples/v2024/v2024.yaml index b17b32cfa..8a436ec6b 100644 --- a/static/code-examples/v2024/v2024.yaml +++ b/static/code-examples/v2024/v2024.yaml @@ -1727,6 +1727,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) post: operationId: createAccessProfile tags: @@ -1881,6 +1903,105 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) /access-profiles/{id}: get: operationId: getAccessProfile @@ -1948,6 +2069,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) patch: operationId: patchAccessProfile tags: @@ -2154,6 +2290,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) delete: operationId: deleteAccessProfile tags: @@ -2270,6 +2428,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) /access-profiles/bulk-delete: post: operationId: deleteAccessProfilesInBulk @@ -2427,6 +2598,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) /access-profiles/{id}/entitlements: get: operationId: getAccessProfileEntitlements @@ -2728,6 +2917,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) /access-requests: post: operationId: createAccessRequest @@ -2850,7 +3059,8 @@ paths: description: The id of the access item requested. example: 779c6fd7171540bba1184e5946112c28 attributesHash: - type: string + type: integer + format: int32 description: a hash representation of the access requested, useful for longer term tracking client side. example: -1928438224 accessRequestIds: @@ -2970,6 +3180,74 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) /access-requests/cancel: post: operationId: cancelAccessRequest @@ -3068,6 +3346,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) /access-requests/bulk-cancel: post: operationId: cancelAccessRequestInBulk @@ -3155,6 +3451,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request-in-bulk + source: | + bulk_cancel_access_request = { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } # BulkCancelAccessRequest | + try: + # Bulk Cancel Access Request + Result = bulk_cancel_access_request.from_json(bulk_cancel_access_request) + api_response = api_instance.cancel_access_request_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request_in_bulk(Result) + print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) /access-request-config: get: operationId: getAccessRequestConfig @@ -3261,6 +3575,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) put: operationId: setAccessRequestConfig security: @@ -3347,6 +3675,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) /access-request-status: get: operationId: listAccessRequestStatus @@ -3465,8 +3833,9 @@ paths: properties: id: type: string - description: The ID of the access request. + description: The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. example: 2c9180926cbfbddd016cbfc7c3b10010 + nullable: true name: type: string description: Human-readable display name of the item being requested. @@ -4024,6 +4393,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) /access-request-administration: get: operationId: listAdministratorsAccessRequestStatus @@ -4144,8 +4537,9 @@ paths: properties: id: type: string - description: ID of the access request + 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. @@ -4332,6 +4726,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#list-administrators-access-request-status + source: | + 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **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, accessRequestId** (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, accessRequestId** (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 for Administrators + + api_response = api_instance.list_administrators_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) + print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) /access-request-approvals/pending: get: operationId: listPendingApprovals @@ -4578,6 +4996,15 @@ paths: sodViolationContext: $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0' x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodViolationContextCheckCompleted.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 '400': $ref: '#/paths/~1access-profiles/get/responses/400' x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml @@ -4615,6 +5042,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-pending-approvals + source: | + 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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) /access-request-approvals/completed: get: operationId: listCompletedApprovals @@ -4872,6 +5319,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-completed-approvals + source: | + 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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) /access-request-approvals/{approvalId}/approve: post: operationId: approveAccessRequest @@ -4981,6 +5448,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#approve-access-request + source: | + 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 + + api_response = api_instance.approve_access_request(approval_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) /access-request-approvals/{approvalId}/reject: post: operationId: rejectAccessRequest @@ -5056,6 +5547,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#reject-access-request + source: | + 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 + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) /access-request-approvals/{approvalId}/forward: post: operationId: forwardAccessRequest @@ -5141,6 +5656,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#forward-access-request + source: | + 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 + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) /access-request-approvals/approval-summary: get: operationId: getAccessRequestApprovalSummary @@ -5232,6 +5766,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) /access-request-approvals/bulk-approve: post: operationId: approveBulkAccessRequest @@ -5317,6 +5867,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#approve-bulk-access-request + source: | + bulk_approve_access_request = { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } # BulkApproveAccessRequest | + try: + # Bulk Approve Access Request + Result = bulk_approve_access_request.from_json(bulk_approve_access_request) + api_response = api_instance.approve_bulk_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_bulk_access_request(Result) + print("The response of AccessRequestsApi->approve_bulk_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) /access-request-approvals/{accessRequestId}/approvers: get: operationId: listAccessRequestApprovers @@ -5435,6 +6003,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-access-request-approvers + source: | + access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID. + 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) + 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) + try: + # Access Request Approvers + + api_response = api_instance.list_access_request_approvers(access_request_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_request_approvers(access_request_id, limit, offset, count) + print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) /accounts: get: operationId: listAccounts @@ -5646,6 +6232,7 @@ paths: example: true identity: description: The identity this account is correlated to + type: object properties: id: type: string @@ -5741,6 +6328,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#list-accounts + 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) + 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 + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) post: operationId: createAccount tags: @@ -5852,6 +6459,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) /accounts/{id}: get: operationId: getAccount @@ -5919,6 +6550,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) patch: operationId: updateAccount tags: @@ -6032,6 +6678,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#update-account + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) put: operationId: putAccount tags: @@ -6133,6 +6797,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) delete: operationId: deleteAccount tags: @@ -6202,6 +6890,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) /accounts/{id}/entitlements: get: operationId: getAccountEntitlements @@ -6280,6 +6983,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#get-account-entitlements + source: | + 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 + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) /accounts/{id}/reload: post: operationId: submitReloadAccount @@ -6347,6 +7068,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) /accounts/{id}/enable: post: operationId: enableAccount @@ -6437,6 +7173,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) /accounts/{id}/disable: post: operationId: disableAccount @@ -6518,6 +7273,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) /accounts/{id}/unlock: post: operationId: unlockAccount @@ -6616,6 +7390,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) /account-activities: get: operationId: listAccountActivities @@ -6817,6 +7611,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-activities#list-account-activities + source: | + 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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) /account-activities/{id}: get: operationId: getAccountActivity @@ -6876,6 +7692,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) /auth-org/network-config: get: operationId: getAuthOrgNetworkConfig @@ -6952,6 +7783,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + try: + # Get security network configuration. + + api_response = api_instance.get_auth_org_network_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) post: operationId: createAuthOrgNetworkConfig tags: @@ -7024,6 +7869,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + 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. + Result = network_configuration.from_json(network_configuration) + api_response = api_instance.create_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) patch: operationId: patchAuthOrgNetworkConfig tags: @@ -7110,6 +7974,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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. + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) /auth-users/{id}: get: operationId: getAuthUser @@ -7282,6 +8167,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-users#get-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + api_response = api_instance.get_auth_user(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) patch: operationId: patchAuthUser tags: @@ -7370,6 +8270,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-users#patch-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_user(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_user(id, Result) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) /brandings: get: operationId: getBrandingList @@ -7464,6 +8386,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#get-branding-list + source: | + try: + # List of branding items + + api_response = api_instance.get_branding_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) post: operationId: createBrandingItem tags: @@ -7568,6 +8504,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#create-branding-item + source: | + 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 + + api_response = api_instance.create_branding_item(name, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) /brandings/{name}: get: operationId: getBranding @@ -7634,6 +8592,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#get-branding + source: | + 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 + + api_response = api_instance.get_branding(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) put: operationId: setBrandingItem tags: @@ -7714,6 +8687,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#set-branding-item + source: | + 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 + + api_response = api_instance.set_branding_item(name, name2, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) delete: operationId: deleteBranding tags: @@ -7775,6 +8771,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/branding#delete-branding + source: | + 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 + + api_instance.delete_branding(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_branding(name) + except Exception as e: + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) /campaigns: get: operationId: getActiveCampaigns @@ -7858,6 +8867,7 @@ paths: readOnly: true description: Id of the campaign example: 2c9079b270a266a60170a2779fcb0007 + nullable: true name: description: | The campaign name. If this object is part of a template, special formatting applies; see the @@ -7873,6 +8883,7 @@ paths: example: Everyone needs to be reviewed by their manager deadline: type: string + nullable: true format: date-time description: 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. example: '2020-03-15T10:00:01.456Z' @@ -7904,6 +8915,7 @@ paths: status: type: string description: The campaign's current status. + nullable: true readOnly: true enum: - PENDING @@ -7915,6 +8927,7 @@ paths: - COMPLETED - ERROR - ARCHIVED + - null example: ACTIVE correlatedStatus: type: string @@ -7925,24 +8938,28 @@ paths: example: CORRELATED created: type: string + nullable: true readOnly: true format: date-time description: Created time of the campaign example: '2020-03-03T22:15:13.611Z' totalCertifications: type: integer + nullable: true format: int32 description: The total number of certifications in this campaign. readOnly: true example: 100 completedCertifications: type: integer + nullable: true format: int32 description: The number of completed certifications in this campaign. readOnly: true example: 10 alerts: type: array + nullable: true description: A list of errors and warnings that have accumulated. readOnly: true items: @@ -7971,11 +8988,13 @@ paths: 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: @@ -8000,6 +9019,7 @@ paths: example: true sourceOwnerCampaignInfo: type: object + nullable: true description: Must be set only if the campaign type is SOURCE_OWNER. properties: sourceIds: @@ -8011,6 +9031,7 @@ paths: - 0fbe863c063c4c88a35fd7f17e8a3df5 searchCampaignInfo: type: object + nullable: true description: Must be set only if the campaign type is SEARCH. properties: type: @@ -8026,6 +9047,7 @@ paths: 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: @@ -8041,14 +9063,17 @@ paths: 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 @@ -8091,10 +9116,18 @@ paths: - 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: @@ -8143,16 +9176,19 @@ paths: - 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: @@ -8170,6 +9206,7 @@ paths: 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: @@ -8406,6 +9443,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) post: operationId: createCampaign tags: @@ -8790,6 +9847,7 @@ paths: "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "IDENTITY" }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "query" : "Search Query", "description" : "Role Composition Description", @@ -8819,6 +9877,130 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign + source: | + 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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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 + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) /campaigns/{id}: get: operationId: getCampaign @@ -8946,6 +10128,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign + source: | + 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 + + api_response = api_instance.get_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) patch: operationId: updateCampaign tags: @@ -9062,6 +10260,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) /campaigns/{id}/reassign: post: security: @@ -9249,6 +10469,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) /campaigns/{id}/activate: post: operationId: startCampaign @@ -9329,6 +10572,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) /campaigns/{id}/complete: post: operationId: completeCampaign @@ -9421,6 +10682,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#complete-campaign + source: | + 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 + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) /campaigns/delete: post: operationId: deleteCampaigns @@ -9495,6 +10774,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaigns + source: | + campaigns_delete_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = campaigns_delete_request.from_json(campaigns_delete_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) /campaigns/{id}/run-remediation-scan: post: operationId: startCampaignRemediationScan @@ -9558,6 +10854,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) /campaigns/{id}/reports: get: operationId: getCampaignReports @@ -9650,6 +10961,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) /campaigns/{id}/run-report/{type}: post: operationId: startCampaignReport @@ -9727,6 +11053,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-report + source: | + 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.v2024.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run. + try: + # Run Campaign Report + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) /campaigns/reports-configuration: get: operationId: getCampaignReportsConfig @@ -9791,6 +11133,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) put: operationId: setCampaignReportsConfig tags: @@ -9857,6 +11213,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) /campaign-filters: post: operationId: createCampaignFilter @@ -10031,6 +11404,38 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#create-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.create_campaign_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_filter(Result) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) get: operationId: listCampaignFilters tags: @@ -10150,6 +11555,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#list-campaign-filters + 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) + 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 + + api_response = api_instance.list_campaign_filters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) /campaign-filters/{id}: get: operationId: getCampaignFilterById @@ -10212,6 +11634,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + 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 + + api_response = api_instance.get_campaign_filter_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) post: operationId: updateCampaignFilter tags: @@ -10299,6 +11736,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#update-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.update_campaign_filter(filter_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign_filter(filter_id, Result) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) /campaign-filters/delete: post: operationId: deleteCampaignFilters @@ -10363,6 +11833,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#delete-campaign-filters + source: | + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + + try: + # Deletes Campaign Filters + Result = request_body.from_json(request_body) + api_instance.delete_campaign_filters(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_filters(Result) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) /campaign-templates: post: operationId: createCampaignTemplate @@ -10441,6 +11926,7 @@ paths: 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: @@ -10842,6 +12328,7 @@ paths: "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "IDENTITY" }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "query" : "Search Query", "description" : "Role Composition Description", @@ -10873,6 +12360,145 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign-template + source: | + 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" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) get: operationId: getCampaignTemplates tags: @@ -11132,6 +12758,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) /campaign-templates/{id}: patch: operationId: patchCampaignTemplate @@ -11242,6 +12887,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) get: operationId: getCampaignTemplate tags: @@ -11321,6 +12988,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) delete: operationId: deleteCampaignTemplate tags: @@ -11382,6 +13064,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) /campaign-templates/{id}/schedule: get: operationId: getCampaignTemplateSchedule @@ -11610,6 +13305,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) put: operationId: setCampaignTemplateSchedule tags: @@ -11765,6 +13475,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) delete: operationId: deleteCampaignTemplateSchedule tags: @@ -11825,6 +13568,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) /campaign-templates/{id}/generate: post: operationId: startGenerateCampaignTemplate @@ -11898,6 +13654,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) /certifications: get: operationId: listIdentityCertifications @@ -12070,6 +13841,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-certifications + source: | + 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 + + api_response = api_instance.list_identity_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) /certifications/{id}: get: operationId: getIdentityCertification @@ -12134,6 +13925,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + api_response = api_instance.get_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) /certifications/{id}/access-review-items: get: operationId: listIdentityAccessReviewItems @@ -12315,6 +14121,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-access-review-items + source: | + 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 + + api_response = api_instance.list_identity_access_review_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) /certifications/{id}/decide: post: operationId: makeIdentityDecision @@ -12459,6 +14288,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#make-identity-decision + source: | + 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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + try: + # Decide on a Certification Item + Result = review_decision.from_json(review_decision) + api_response = api_instance.make_identity_decision(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.make_identity_decision(id, Result) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) /certifications/{id}/reassign: post: operationId: reassignIdentityCertifications @@ -12556,6 +14414,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#reassign-identity-certifications + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.reassign_identity_certifications(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reassign_identity_certifications(id, Result) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) /certifications/{id}/sign-off: post: operationId: signOffIdentityCertification @@ -12620,6 +14504,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#sign-off-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + api_response = api_instance.sign_off_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) /certifications/{id}/decision-summary: get: operationId: getIdentityDecisionSummary @@ -12777,6 +14676,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + 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 + + api_response = api_instance.get_identity_decision_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) /certifications/{id}/identity-summaries: get: operationId: getIdentitySummaries @@ -12906,6 +14821,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries + source: | + 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 + + api_response = api_instance.get_identity_summaries(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) /certifications/{id}/access-summaries/{type}: get: operationId: getIdentityAccessSummaries @@ -13374,6 +15309,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + 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 + + api_response = api_instance.get_identity_access_summaries(id, type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) /certifications/{id}/identity-summaries/{identitySummaryId}: get: operationId: getIdentitySummary @@ -13447,6 +15403,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary + source: | + 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 + + api_response = api_instance.get_identity_summary(id, identity_summary_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) /certifications/{certificationId}/access-review-items/{itemId}/permissions: get: operationId: getIdentityCertificationItemPermissions @@ -13569,6 +15541,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification-item-permissions + source: | + 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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) /certifications/{id}/reviewers: get: operationId: listCertificationReviewers @@ -13672,6 +15664,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) /certifications/{id}/reassign-async: post: operationId: submitReassignCertsAsync @@ -13763,6 +15775,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) /certification-tasks/{id}: get: operationId: getCertificationTask @@ -13828,6 +15866,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-certification-task + source: | + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + api_response = api_instance.get_certification_task(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) /certification-tasks: get: operationId: getPendingCertificationTasks @@ -13916,6 +15969,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/certifications#get-pending-certification-tasks + source: | + 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 + + api_response = api_instance.get_pending_certification_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}: get: operationId: getObjectMappings @@ -14062,6 +16134,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-object-mappings + source: | + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + api_response = api_instance.get_object_mappings(source_org) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) post: operationId: createObjectMapping security: @@ -14213,6 +16300,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mapping + source: | + 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 + Result = object_mapping_request.from_json(object_mapping_request) + api_response = api_instance.create_object_mapping(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mapping(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}: delete: operationId: deleteObjectMapping @@ -14282,6 +16391,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-object-mapping + source: | + 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 + + api_instance.delete_object_mapping(source_org, object_mapping_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_object_mapping(source_org, object_mapping_id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}/bulk-create: post: operationId: createObjectMappings @@ -14417,6 +16540,36 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mappings + source: | + 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 + Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + api_response = api_instance.create_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}/bulk-patch: post: operationId: updateObjectMappings @@ -14561,6 +16714,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#update-object-mappings + source: | + 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 + Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + api_response = api_instance.update_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) /configuration-hub/backups/uploads: get: operationId: listUploadedConfigurations @@ -14793,6 +16975,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-uploaded-configurations + source: | + 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 + + api_response = api_instance.list_uploaded_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) post: operationId: createUploadedConfiguration security: @@ -14952,6 +17149,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-uploaded-configuration + source: | + 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 + + api_response = api_instance.create_uploaded_configuration(data, name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) /configuration-hub/backups/uploads/{id}: get: operationId: getUploadedConfiguration @@ -15030,6 +17243,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-uploaded-configuration + source: | + 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 + + api_response = api_instance.get_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) delete: operationId: deleteUploadedConfiguration security: @@ -15091,6 +17319,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-uploaded-configuration + source: | + 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 + + api_instance.delete_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_uploaded_configuration(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) /configuration-hub/backups: get: operationId: listBackups @@ -15181,6 +17422,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-backups + source: | + 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 Backups + + api_response = api_instance.list_backups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_backups(filters) + print("The response of ConfigurationHubApi->list_backups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) /configuration-hub/backups/{id}: delete: operationId: deleteBackup @@ -15243,6 +17499,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-backup + source: | + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete. + try: + # Delete a Backup + + api_instance.delete_backup(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_backup(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) /configuration-hub/drafts: get: operationId: listDrafts @@ -15455,6 +17724,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-drafts + source: | + 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* **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: **status**: *eq* **approvalStatus**: *eq* (optional) + try: + # List Drafts + + api_response = api_instance.list_drafts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_drafts(filters) + print("The response of ConfigurationHubApi->list_drafts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) /configuration-hub/drafts/{id}: delete: operationId: deleteDraft @@ -15517,6 +17801,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-draft + source: | + id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete. + try: + # Delete a draft + + api_instance.delete_draft(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_draft(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) /configuration-hub/deploys: get: operationId: listDeploys @@ -15663,6 +17960,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-deploys + source: | + try: + # List Deploys + + api_response = api_instance.list_deploys() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_deploys() + print("The response of ConfigurationHubApi->list_deploys:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) post: operationId: createDeploy security: @@ -15744,6 +18055,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-deploy + source: | + deploy_request = { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } # DeployRequest | The deploy request body. + try: + # Create a Deploy + Result = deploy_request.from_json(deploy_request) + api_response = api_instance.create_deploy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_deploy(Result) + print("The response of ConfigurationHubApi->create_deploy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) /configuration-hub/deploys/{id}: get: operationId: getDeploy @@ -15819,6 +18147,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-deploy + source: | + id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy. + try: + # Get a Deploy + + api_response = api_instance.get_deploy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_deploy(id) + print("The response of ConfigurationHubApi->get_deploy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) /connectors/{scriptName}: get: tags: @@ -15913,6 +18256,7 @@ paths: sourceConfig: type: string + nullable: true description: The connector source config example: |-
@@ -15925,6 +18269,7 @@ paths:
sourceConfigFrom: type: string + nullable: true description: The connector source config origin example: sp-connect s3Location: @@ -16039,6 +18384,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector + source: | + 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 + + api_response = api_instance.get_connector(script_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) delete: tags: - Connectors @@ -16102,6 +18463,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#delete-custom-connector + source: | + 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 + + api_instance.delete_custom_connector(script_name) + + # Below is a request that includes all optional parameters + # api_instance.delete_custom_connector(script_name) + except Exception as e: + print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) patch: tags: - Connectors @@ -16199,6 +18573,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#update-connector + source: | + 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. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + try: + # Update Connector by Script Name + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_connector(script_name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector(script_name, Result) + print("The response of ConnectorsApi->update_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) /connectors: get: tags: @@ -16370,6 +18766,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-list + source: | + 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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) post: tags: - Connectors @@ -16471,6 +18886,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#create-custom-connector + source: | + v3_create_connector_dto = { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } # V3CreateConnectorDto | + try: + # Create Custom Connector + Result = v3_create_connector_dto.from_json(v3_create_connector_dto) + api_response = api_instance.create_custom_connector(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_connector(Result) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) /connectors/{scriptName}/source-config: get: tags: @@ -16539,6 +18975,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-config + source: | + 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 + + api_response = api_instance.get_connector_source_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) put: tags: - Connectors @@ -16645,6 +19096,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-config + source: | + 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 + + api_response = api_instance.put_connector_source_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) /connectors/{scriptName}/translations/{locale}: get: tags: @@ -16741,6 +19208,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-translations + source: | + 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 + + api_response = api_instance.get_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) put: tags: - Connectors @@ -16842,6 +19325,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-translations + source: | + 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 + + api_response = api_instance.put_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) /connectors/{scriptName}/source-template: get: tags: @@ -16910,6 +19409,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-template + source: | + 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 + + api_response = api_instance.get_connector_source_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) put: tags: - Connectors @@ -16991,6 +19505,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-template + source: | + 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 + + api_response = api_instance.put_connector_source_template(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) /connectors/{scriptName}/correlation-config: get: tags: @@ -17059,6 +19589,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-correlation-config + source: | + 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 Correlation Configuration + + api_response = api_instance.get_connector_correlation_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_correlation_config(script_name) + print("The response of ConnectorsApi->get_connector_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) put: tags: - Connectors @@ -17140,6 +19685,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-correlation-config + source: | + 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 correlation config xml file # bytearray | connector correlation config xml file + try: + # Update Connector Correlation Configuration + + api_response = api_instance.put_connector_correlation_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_correlation_config(script_name, file) + print("The response of ConnectorsApi->put_connector_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) /data-segments/membership/{identityId}: get: operationId: getDataSegmentIdentityMembership @@ -17240,6 +19801,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment-identity-membership + source: | + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. + x_sail_point_experimental = 'true' # 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 SegmentMembership by Identity ID + + api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) /data-segments/user-enabled/{identityId}: get: operationId: getDataSegmentationEnabledForUser @@ -17313,6 +19890,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. + x_sail_point_experimental = 'true' # 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: + # Is Segmentation enabled by Identity + + api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) /data-segments/{segmentId}: get: operationId: getDataSegment @@ -17537,6 +20130,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + x_sail_point_experimental = 'true' # 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 Segment by ID + + api_response = api_instance.get_data_segment(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_data_segment(id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) post: operationId: publishDataSegment security: @@ -17619,6 +20228,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#publish-data-segment + source: | + x_sail_point_experimental = 'true' # 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] | A list of segment ids that you wish to publish + request_body = ['request_body_example'] # List[str] | A list of segment ids that you wish to publish + + publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) + try: + # Publish segment by ID + Result = request_body.from_json(request_body) + api_instance.publish_data_segment(x_sail_point_experimental, Result, ) + + # Below is a request that includes all optional parameters + # api_instance.publish_data_segment(x_sail_point_experimental, Result, publish_all) + except Exception as e: + print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) patch: operationId: patchDataSegment security: @@ -17735,6 +20361,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#patch-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + x_sail_point_experimental = 'true' # 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 = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + request_body = [{op=replace, path=/memberFilter, 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 * membership * memberFilter * memberSelection * scopes * enabled + + try: + # Update Segment + Result = request_body.from_json(request_body) + api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) + print("The response of DataSegmentationApi->patch_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) delete: operationId: deleteDataSegment security: @@ -17812,6 +20457,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#delete-data-segment + source: | + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID 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') + published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False) + try: + # Delete Segment by ID + + api_instance.delete_data_segment(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_data_segment(id, x_sail_point_experimental, published) + except Exception as e: + print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) /data-segments: get: operationId: listDataSegments @@ -17931,6 +20591,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#list-data-segments + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) + unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) + published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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 = 'name 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, in, sw* **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, sw* **name**: *eq, in, sw* (optional) + try: + # Get Segments + + api_response = api_instance.list_data_segments(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) + print("The response of DataSegmentationApi->list_data_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) post: operationId: createDataSegment security: @@ -17996,6 +20678,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/data-segmentation#create-data-segment + source: | + data_segment = sailpoint.v2024.DataSegment() # DataSegment | + try: + # Create Segment + Result = data_segment.from_json(data_segment) + api_response = api_instance.create_data_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_data_segment(Result) + print("The response of DataSegmentationApi->create_data_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) /identities/{identity-id}/set-lifecycle-state: post: operationId: setLifecycleState @@ -18079,6 +20776,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#set-lifecycle-state + source: | + identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update. + set_lifecycle_state_request = sailpoint.v2024.SetLifecycleStateRequest() # SetLifecycleStateRequest | + try: + # Set Lifecycle State + Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request) + api_response = api_instance.set_lifecycle_state(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_lifecycle_state(identity_id, Result) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) /identity-profiles/{identity-profile-id}/lifecycle-states: get: operationId: getLifecycleStates @@ -18145,6 +20858,7 @@ paths: description: The lifecycle state's technical name. This is for internal use. description: type: string + nullable: true example: Lifecycle description description: Lifecycle state's description. identityCount: @@ -18252,6 +20966,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) post: operationId: createLifecycleState tags: @@ -18350,6 +21083,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#create-lifecycle-state + source: | + 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 + Result = lifecycle_state.from_json(lifecycle_state) + api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}: get: operationId: getLifecycleState @@ -18423,6 +21196,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-state + source: | + 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 + + api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) patch: operationId: updateLifecycleStates tags: @@ -18548,6 +21337,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) delete: operationId: deleteLifecycleState tags: @@ -18637,6 +21449,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#delete-lifecycle-state + source: | + 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 + + api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) /identity-profiles: get: operationId: listIdentityProfiles @@ -18803,6 +21631,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#list-identity-profiles + 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) + 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) post: operationId: createIdentityProfile summary: Create Identity Profile @@ -18912,6 +21759,69 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#create-identity-profile + source: | + 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 + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) /identity-profiles/bulk-delete: post: operationId: deleteIdentityProfiles @@ -19021,6 +21931,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) /identity-profiles/export: get: operationId: exportIdentityProfiles @@ -19161,6 +22088,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#export-identity-profiles + 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) + 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) /identity-profiles/import: post: operationId: importIdentityProfiles @@ -19356,6 +22302,79 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.v2024.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) /identity-profiles/{identity-profile-id}: get: operationId: getIdentityProfile @@ -19423,6 +22442,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) delete: operationId: deleteIdentityProfile tags: @@ -19489,6 +22523,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) patch: operationId: updateIdentityProfile tags: @@ -19593,6 +22642,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) /identity-profiles/{identity-profile-id}/default-identity-attribute-config: get: operationId: getDefaultIdentityAttributeConfig @@ -19658,6 +22729,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) /identity-profiles/{identity-profile-id}/process-identities: post: operationId: syncIdentityProfile @@ -19727,6 +22813,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) /managed-clients: get: tags: @@ -19951,6 +23052,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-clients + source: | + 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 + + api_response = api_instance.get_managed_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) post: tags: - Managed Clients @@ -20041,6 +23160,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#create-managed-client + source: | + managed_client_request = { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } # ManagedClientRequest | + try: + # Create Managed Client + Result = managed_client_request.from_json(managed_client_request) + api_response = api_instance.create_managed_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_client(Result) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) /managed-clients/{id}: get: tags: @@ -20108,6 +23247,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + api_response = api_instance.get_managed_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) patch: tags: - Managed Clients @@ -20188,6 +23342,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#update-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Client + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client(id, Result) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) delete: operationId: deleteManagedClient tags: @@ -20244,6 +23420,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#delete-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + api_instance.delete_managed_client(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) /managed-clients/{id}/status: get: tags: @@ -20376,6 +23565,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client-status + source: | + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v2024.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) /managed-clusters: get: tags: @@ -20626,6 +23831,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-clusters + source: | + 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 + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) post: tags: - Managed Clusters @@ -20721,6 +23944,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster + source: | + 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 + Result = managed_cluster_request.from_json(managed_cluster_request) + api_response = api_instance.create_managed_cluster(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_cluster(Result) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) /managed-clusters/{id}: get: tags: @@ -20788,6 +24034,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) patch: tags: - Managed Clusters @@ -20868,6 +24129,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Cluster + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_cluster(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_cluster(id, Result) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) delete: operationId: deleteManagedCluster tags: @@ -20933,6 +24216,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#delete-managed-cluster + source: | + 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 + + api_instance.delete_managed_cluster(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) /managed-clusters/{id}/log-config: get: tags: @@ -21044,6 +24341,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-client-log-configuration + source: | + 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 + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) put: tags: - Managed Clusters @@ -21185,6 +24497,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/managed-clusters#put-client-log-configuration + source: | + 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.v2024.PutClientLogConfigurationRequest() # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request) + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) /mfa/okta-verify/config: get: operationId: getMFAOktaConfig @@ -21268,6 +24596,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) put: operationId: setMFAOktaConfig tags: @@ -21347,6 +24689,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) /mfa/duo-web/config: get: operationId: getMFADuoConfig @@ -21441,6 +24804,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) put: operationId: setMFADuoConfig tags: @@ -21530,6 +24907,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) /mfa/kba/config: get: operationId: getMFAKbaConfig @@ -21633,6 +25035,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) /mfa/kba/config/answers: post: operationId: setMFAKBAConfig @@ -21748,6 +25165,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) /mfa/{method}/test: get: operationId: testMFAConfig @@ -21830,6 +25267,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) /non-employee-records: post: operationId: createNonEmployeeRecord @@ -22018,6 +25470,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) get: operationId: listNonEmployeeRecords security: @@ -22105,6 +25585,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) /non-employee-records/{id}: get: operationId: getNonEmployeeRecord @@ -22163,6 +25662,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) put: operationId: updateNonEmployeeRecord security: @@ -22253,6 +25767,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) patch: operationId: patchNonEmployeeRecord security: @@ -22339,6 +25882,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) delete: operationId: deleteNonEmployeeRecord tags: @@ -22392,6 +25957,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_record(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) /non-employee-records/bulk-delete: post: operationId: deleteNonEmployeeRecordsInBulk @@ -22457,6 +26035,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + delete_non_employee_records_in_bulk_request = sailpoint.v2024.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + api_instance.delete_non_employee_records_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_records_in_bulk(Result) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) /non-employee-requests: post: operationId: createNonEmployeeRequest @@ -22687,6 +26278,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) get: operationId: listNonEmployeeRequests security: @@ -22784,6 +26403,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) /non-employee-requests/{id}: get: operationId: getNonEmployeeRequest @@ -22850,6 +26489,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) delete: operationId: deleteNonEmployeeRequest tags: @@ -22907,6 +26561,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + 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 + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) /non-employee-requests/summary/{requested-for}: get: operationId: getNonEmployeeRequestSummary @@ -22991,6 +26658,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) /non-employee-sources: post: operationId: createNonEmployeeSource @@ -23126,6 +26808,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) get: operationId: listNonEmployeeSources security: @@ -23229,6 +26951,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) /non-employee-sources/{sourceId}: get: operationId: getNonEmployeeSource @@ -23328,6 +27070,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) patch: operationId: patchNonEmployeeSource tags: @@ -23410,6 +27167,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) delete: operationId: deleteNonEmployeeSource tags: @@ -23461,6 +27240,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_source(source_id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) /non-employee-sources/{id}/non-employees/download: get: operationId: exportNonEmployeeRecords @@ -23521,6 +27313,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.export_non_employee_records(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) /non-employee-sources/{id}/non-employee-bulk-upload: post: operationId: importNonEmployeeRecordsInBulk @@ -23633,6 +27438,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) /non-employee-sources/{id}/non-employee-bulk-upload/status: get: operationId: getNonEmployeeBulkUploadStatus @@ -23706,6 +27527,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) /non-employee-sources/{id}/schema-attributes-template/download: get: operationId: exportNonEmployeeSourceSchemaTemplate @@ -23764,6 +27600,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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) /non-employee-approvals: get: operationId: listNonEmployeeApprovals @@ -23880,6 +27729,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + 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 + + api_response = api_instance.list_non_employee_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) /non-employee-approvals/{id}: get: operationId: getNonEmployeeApproval @@ -24034,6 +27903,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) /non-employee-approvals/{id}/approve: post: operationId: approveNonEmployeeRequest @@ -24110,6 +27995,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + 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 + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) /non-employee-approvals/{id}/reject: post: operationId: rejectNonEmployeeRequest @@ -24188,6 +28091,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + 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 + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) /non-employee-approvals/summary/{requested-for}: get: operationId: getNonEmployeeApprovalSummary @@ -24266,6 +28187,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) /non-employee-sources/{sourceId}/schema-attributes: get: operationId: getNonEmployeeSourceSchemaAttributes @@ -24385,6 +28321,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) post: operationId: createNonEmployeeSourceSchemaAttributes tags: @@ -24488,6 +28439,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + 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 + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) delete: operationId: deleteNonEmployeeSourceSchemaAttributes tags: @@ -24539,6 +28513,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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) /non-employee-sources/{sourceId}/schema-attributes/{attributeId}: get: operationId: getNonEmployeeSchemaAttribute @@ -24606,6 +28593,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + 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 + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) patch: operationId: patchNonEmployeeSchemaAttribute tags: @@ -24697,6 +28700,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + 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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) delete: operationId: deleteNonEmployeeSchemaAttribute tags: @@ -24759,6 +28785,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + 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 + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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) /oauth-clients: get: operationId: listOauthClients @@ -24961,6 +29001,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) post: operationId: createOauthClient security: @@ -25237,6 +29292,37 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#create-oauth-client + source: | + 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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) /oauth-clients/{id}: get: operationId: getOauthClient @@ -25300,6 +29386,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) delete: operationId: deleteOauthClient security: @@ -25356,6 +29457,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_oauth_client(id) + except Exception as e: + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) patch: operationId: patchOauthClient security: @@ -25457,6 +29571,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) /password-sync-groups: get: operationId: getPasswordSyncGroups @@ -25552,6 +29688,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) post: operationId: createPasswordSyncGroup tags: @@ -25633,6 +29786,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) /password-sync-groups/{id}: get: operationId: getPasswordSyncGroup @@ -25704,6 +29879,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) put: operationId: updatePasswordSyncGroup tags: @@ -25799,6 +29989,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) delete: operationId: deletePasswordSyncGroup tags: @@ -25855,6 +30068,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_password_sync_group(id) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) /password-policies/{id}: get: operationId: getPasswordPolicyById @@ -25898,14 +30124,14 @@ paths: description: The name of the password policy. example: PasswordPolicy Example dateCreated: - type: string - format: date-time + type: integer + format: int64 description: Date the Password Policy was created. example: 1639056206564 lastUpdated: - type: string + type: integer + format: int64 nullable: true - format: date-time description: Date the Password Policy was updated. example: 1939056206564 firstExpirationReminder: @@ -26104,6 +30330,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) put: operationId: setPasswordPolicy tags: @@ -26234,9 +30475,9 @@ paths: "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "lastUpdated" : 1939056206564, "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "dateCreated" : 1639056206564, "accountNameMinWordLength" : 6, "minUpper" : 8, "firstExpirationReminder" : 45, @@ -26274,6 +30515,54 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) delete: operationId: deletePasswordPolicy tags: @@ -26333,6 +30622,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_password_policy(id) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) /password-policies: post: operationId: createPasswordPolicy @@ -26422,9 +30724,9 @@ paths: "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "lastUpdated" : 1939056206564, "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "dateCreated" : 1639056206564, "accountNameMinWordLength" : 6, "minUpper" : 8, "firstExpirationReminder" : 45, @@ -26462,6 +30764,53 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) get: operationId: listPasswordPolicies tags: @@ -26585,6 +30934,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) /personal-access-tokens: get: operationId: listPersonalAccessTokens @@ -26723,6 +31089,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) post: operationId: createPersonalAccessToken security: @@ -26863,6 +31245,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) /personal-access-tokens/{id}: patch: operationId: patchPersonalAccessToken @@ -26957,6 +31358,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) delete: operationId: deletePersonalAccessToken security: @@ -27014,6 +31437,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_personal_access_token(id) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) /public-identities: get: operationId: getPublicIdentities @@ -27231,6 +31667,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/public-identities#get-public-identities + 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) + 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 + + api_response = api_instance.get_public_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) /public-identities-config: get: operationId: getPublicIdentityConfig @@ -27306,6 +31762,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get the Public Identities Configuration + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) put: operationId: updatePublicIdentityConfig tags: @@ -27380,6 +31850,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/public-identities-config#update-public-identity-config + source: | + 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 + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) /requestable-objects: get: operationId: listRequestableObjects @@ -27565,6 +32064,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/requestable-objects#list-requestable-objects + source: | + 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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) /roles: get: operationId: listRoles @@ -28023,6 +32549,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) post: operationId: createRole tags: @@ -28251,6 +32799,178 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) /roles/{id}: get: operationId: getRole @@ -28319,6 +33039,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) patch: operationId: patchRole tags: @@ -28497,6 +33232,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) delete: operationId: deleteRole tags: @@ -28559,6 +33316,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) /roles/bulk-delete: post: operationId: deleteBulkRoles @@ -28696,6 +33466,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) /roles/{id}/assigned-identities: get: operationId: getRoleAssignedIdentities @@ -28821,6 +33608,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role-assigned-identities + source: | + 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 + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) /roles/{roleId}/dimensions: get: operationId: listDimensions @@ -29079,6 +33886,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimensions + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + 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 = 'id eq \'2c918086749d78830174a1a40e121518\'' # 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* (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* (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) + try: + # List Dimensions + + api_response = api_instance.list_dimensions(role_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimensions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) post: operationId: createDimension tags: @@ -29243,6 +34071,108 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#create-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension = { + "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" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "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.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } # Dimension | + try: + # Create a Dimension + Result = dimension.from_json(dimension) + api_response = api_instance.create_dimension(role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_dimension(role_id, Result) + print("The response of DimensionsApi->create_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) /roles/{roleId}/dimensions/{dimensionId}: get: operationId: getDimension @@ -29321,6 +34251,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + try: + # Get a Dimension under Role. + + api_response = api_instance.get_dimension(role_id, dimension_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dimension(role_id, dimension_id) + print("The response of DimensionsApi->get_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) patch: operationId: patchDimension tags: @@ -29461,6 +34407,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#patch-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + [{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Dimension + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_dimension(role_id, dimension_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_dimension(role_id, dimension_id, Result) + print("The response of DimensionsApi->patch_dimension:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) delete: operationId: deleteDimension tags: @@ -29531,6 +34500,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-dimension + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + try: + # Delete a Dimension + + api_instance.delete_dimension(role_id, dimension_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_dimension(role_id, dimension_id) + except Exception as e: + print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) /roles/{roleId}/dimensions/bulk-delete: post: operationId: deleteBulkDimensions @@ -29662,6 +34645,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-bulk-dimensions + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. + dimension_bulk_delete_request = { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # DimensionBulkDeleteRequest | + try: + # Delete Dimension(s) + Result = dimension_bulk_delete_request.from_json(dimension_bulk_delete_request) + api_response = api_instance.delete_bulk_dimensions(role_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_dimensions(role_id, Result) + print("The response of DimensionsApi->delete_bulk_dimensions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) /roles/{roleId}/dimensions/{dimensionId}/access-profiles: get: operationId: listDimensionAccessProfiles @@ -29789,6 +34790,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimension-access-profiles + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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 = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # 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* **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* **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, 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 Dimension's Access Profiles + + api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimension_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) /roles/{roleId}/dimensions/{dimensionId}/entitlements: get: operationId: getDimensionEntitlements @@ -29917,6 +34939,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension-entitlements + source: | + role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. + dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension + 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* (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 Dimension's Entitlements + + api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->get_dimension_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) /saved-searches: post: security: @@ -30007,6 +35050,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#create-saved-search + source: | + create_saved_search_request = sailpoint.v2024.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + Result = create_saved_search_request.from_json(create_saved_search_request) + api_response = api_instance.create_saved_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_saved_search(Result) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) get: security: - userAuth: @@ -30086,6 +35144,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#list-saved-searches + source: | + 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 + + api_response = api_instance.list_saved_searches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) /saved-searches/{id}: put: tags: @@ -30202,6 +35278,66 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#put-saved-search + source: | + 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 + Result = saved_search.from_json(saved_search) + api_response = api_instance.put_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_saved_search(id, Result) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) get: tags: - Saved Search @@ -30261,6 +35397,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#get-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + api_response = api_instance.get_saved_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) delete: tags: - Saved Search @@ -30315,6 +35466,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#delete-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + api_instance.delete_saved_search(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) /saved-searches/{id}/execute: post: tags: @@ -30432,6 +35596,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/saved-search#execute-saved-search + source: | + 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 + Result = search_arguments.from_json(search_arguments) + api_instance.execute_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.execute_saved_search(id, Result) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) /scheduled-searches: post: tags: @@ -30639,6 +35827,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#create-scheduled-search + source: | + 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 + Result = create_scheduled_search_request.from_json(create_scheduled_search_request) + api_response = api_instance.create_scheduled_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_scheduled_search(Result) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) get: tags: - Scheduled Search @@ -30720,6 +35923,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#list-scheduled-search + source: | + 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 + + api_response = api_instance.list_scheduled_search() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) /scheduled-searches/{id}: put: tags: @@ -30882,6 +36103,112 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#update-scheduled-search + source: | + 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 + Result = scheduled_search.from_json(scheduled_search) + api_response = api_instance.update_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_scheduled_search(id, Result) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) get: tags: - Scheduled Search @@ -30940,6 +36267,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#get-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + api_response = api_instance.get_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) delete: tags: - Scheduled Search @@ -30994,6 +36336,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#delete-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + api_instance.delete_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_scheduled_search(id) + except Exception as e: + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) /scheduled-searches/{id}/unsubscribe: post: tags: @@ -31050,6 +36405,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/scheduled-search#unsubscribe-scheduled-search + source: | + 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 + Result = typed_reference.from_json(typed_reference) + api_instance.unsubscribe_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.unsubscribe_scheduled_search(id, Result) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) /search: post: tags: @@ -33346,6 +38718,140 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_post(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_post(Result, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) /search/count: post: tags: @@ -33527,6 +39033,135 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } + } + } # Search | + try: + # Count Documents Satisfying a Query + Result = search.from_json(search) + api_instance.search_count(Result) + + # Below is a request that includes all optional parameters + # api_instance.search_count(Result) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) /search/aggregate: post: tags: @@ -33911,6 +39546,140 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_aggregate(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_aggregate(Result, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) /search/{index}/{id}: get: tags: @@ -34504,6 +40273,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search#search-get + source: | + 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 + + api_response = api_instance.search_get(index, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) /segments: post: operationId: createSegment @@ -34644,6 +40429,44 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) get: operationId: listSegments security: @@ -34710,6 +40533,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) /segments/{id}: get: operationId: getSegment @@ -34778,6 +40618,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) delete: operationId: deleteSegment security: @@ -34840,6 +40695,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) patch: operationId: patchSegment security: @@ -34948,6 +40816,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) /service-desk-integrations: get: tags: @@ -35126,6 +41012,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integrations + source: | + 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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) post: tags: - Service Desk Integration @@ -35224,6 +41129,54 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#create-service-desk-integration + source: | + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) /service-desk-integrations/{id}: get: tags: @@ -35291,6 +41244,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) put: tags: - Service Desk Integration @@ -35401,6 +41369,55 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) delete: tags: - Service Desk Integration @@ -35461,6 +41478,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) patch: operationId: patchServiceDeskIntegration tags: @@ -35557,6 +41587,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v2024.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) /service-desk-integrations/types: get: tags: @@ -35630,6 +41676,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) /service-desk-integrations/templates/{scriptName}: get: tags: @@ -35721,6 +41781,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) /service-desk-integrations/status-check-configuration: get: tags: @@ -35788,6 +41863,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) put: tags: - Service Desk Integration @@ -35856,6 +41945,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) /query-password-info: post: operationId: queryPasswordInfo @@ -35967,6 +42074,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) /set-password: post: operationId: setPassword @@ -36084,6 +42209,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#set-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password(Result) + print("The response of PasswordManagementApi->set_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) /password-change-status/{id}: get: operationId: getPasswordChangeStatus @@ -36175,6 +42321,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#get-password-change-status + source: | + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + api_response = api_instance.get_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) /password-dictionary: get: operationId: getPasswordDictionary @@ -36257,6 +42418,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) put: operationId: putPasswordDictionary tags: @@ -36348,6 +42523,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) /password-org-config: get: operationId: getPasswordOrgConfig @@ -36428,6 +42616,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) put: operationId: putPasswordOrgConfig tags: @@ -36503,6 +42705,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) post: operationId: createPasswordOrgConfig tags: @@ -36580,6 +42802,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) /reports/{taskResultId}/result: get: tags: @@ -36716,6 +42958,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report-result + source: | + 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 + + api_response = api_instance.get_report_result(task_result_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) /reports/run: post: tags: @@ -37150,6 +43408,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#start-report + source: | + report_details = { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } # ReportDetails | + try: + # Run Report + Result = report_details.from_json(report_details) + api_response = api_instance.start_report(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_report(Result) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) /reports/{id}/cancel: post: tags: @@ -37207,6 +43486,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#cancel-report + source: | + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + api_instance.cancel_report(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) /reports/{taskResultId}: get: tags: @@ -37321,6 +43613,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report + source: | + 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 + + api_response = api_instance.get_report(task_result_id, file_format, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) /sod-policies: post: security: @@ -37747,6 +44057,76 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) get: security: - userAuth: @@ -37901,6 +44281,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) /sod-policies/{id}: get: security: @@ -38032,6 +44431,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy + source: | + 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 + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) put: security: - userAuth: @@ -38285,6 +44699,77 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) delete: security: - userAuth: @@ -38352,6 +44837,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy + source: | + 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 + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) patch: security: - userAuth: @@ -38533,6 +45032,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy + source: | + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) /sod-policies/{id}/evaluate: post: security: @@ -38626,6 +45147,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + 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 + + api_response = api_instance.start_evaluate_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) /sod-policies/{id}/schedule: get: security: @@ -38743,6 +45279,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + 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 + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) put: security: - userAuth: @@ -38897,6 +45448,107 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule + source: | + 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 + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) delete: security: - userAuth: @@ -38953,6 +45605,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -39020,6 +45685,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy + source: | + 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 + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) /sod-policies/{id}/violation-report: get: security: @@ -39087,6 +45767,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + 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: @@ -39154,6 +45849,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) /sod-violations/predict: post: security: @@ -39368,6 +46078,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) /sod-violations/check: post: security: @@ -39497,6 +46233,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check + source: | + 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 + Result = identity_with_new_access1.from_json(identity_with_new_access1) + api_response = api_instance.start_violation_check(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_violation_check(Result) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) /sod-violation-report/run: post: security: @@ -39575,6 +46326,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + 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 + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) /sod-violation-report: get: security: @@ -39629,6 +46397,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + 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: @@ -39691,6 +46473,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) /sod-violation-report/{reportResultId}/download/{fileName}: get: security: @@ -39761,6 +46558,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) /sources: get: operationId: listSources @@ -40215,6 +47028,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#list-sources + 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) + 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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) post: operationId: createSource security: @@ -40369,6 +47203,104 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) /sources/{id}: get: operationId: getSource @@ -40435,6 +47367,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) put: operationId: putSource security: @@ -40605,6 +47552,104 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) patch: operationId: updateSource security: @@ -40757,6 +47802,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) delete: operationId: deleteSource security: @@ -40845,6 +47912,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) /sources/{sourceId}/provisioning-policies: get: operationId: listProvisioningPolicies @@ -40933,6 +48015,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) post: operationId: createProvisioningPolicy tags: @@ -41117,6 +48214,61 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) /sources/{sourceId}/provisioning-policies/{usageType}: get: operationId: getProvisioningPolicy @@ -41208,6 +48360,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) put: operationId: putProvisioningPolicy tags: @@ -41347,6 +48515,62 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) patch: operationId: updateProvisioningPolicy tags: @@ -41467,6 +48691,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v2024.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) delete: operationId: deleteProvisioningPolicy tags: @@ -41545,6 +48792,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2024.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -41664,6 +48925,63 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v2024.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + 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 +49056,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: @@ -41774,6 +49093,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,6 +49153,7 @@ 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' @@ -41873,6 +49194,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) post: operationId: createSourceSchema security: @@ -41979,6 +49317,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.v2024.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) /sources/{sourceId}/schedules: get: operationId: getSourceSchedules @@ -42061,6 +49415,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedules + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # List Schedules on Source + + api_response = api_instance.get_source_schedules(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schedules(source_id) + print("The response of SourcesApi->get_source_schedules:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) post: operationId: createSourceSchedule security: @@ -42135,6 +49504,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schedule + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + schedule1 = sailpoint.v2024.Schedule1() # Schedule1 | + try: + # Create Schedule on Source + Result = schedule1.from_json(schedule1) + api_response = api_instance.create_source_schedule(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schedule(source_id, Result) + print("The response of SourcesApi->create_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) /sources/{sourceId}/schedules/{scheduleType}: get: operationId: getSourceSchedule @@ -42213,6 +49598,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedule + source: | + 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 + + api_response = api_instance.get_source_schedule(source_id, schedule_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schedule(source_id, schedule_type) + print("The response of SourcesApi->get_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) patch: operationId: updateSourceSchedule security: @@ -42318,6 +49719,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schedule + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. + [{op=replace, path=/cronExpression, value=0 0 6 * * ?}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + + try: + # Update Source Schedule (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + print("The response of SourcesApi->update_source_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) delete: operationId: deleteSourceSchedule security: @@ -42389,6 +49813,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schedule + source: | + 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. + + api_instance.delete_source_schedule(source_id, schedule_type) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -42458,6 +49896,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) put: operationId: putSourceSchema tags: @@ -42579,6 +50033,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source-schema + source: | + 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.v2024.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) patch: operationId: updateSourceSchema tags: @@ -42706,6 +50177,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) delete: operationId: deleteSourceSchema tags: @@ -42768,6 +50262,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.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 +50339,7 @@ paths: example: megapod-useast1 iqServiceVersion: type: string + nullable: true description: The version of the iqService example: iqVersion123 status: @@ -42846,6 +50355,7 @@ 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': @@ -42883,6 +50393,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-health + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + api_response = api_instance.get_source_health(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) /sources/{id}/schemas/accounts: get: tags: @@ -42945,6 +50470,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_accounts_schema(id) + + # Below is a request that includes all optional parameters + # api_instance.get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) post: tags: - Sources @@ -43021,6 +50559,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_accounts_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) /sources/{id}/schemas/entitlements: get: tags: @@ -43091,6 +50645,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-entitlements-schema + source: | + 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 + + api_instance.get_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) post: tags: - Sources @@ -43174,6 +50742,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-entitlements-schema + source: | + 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 + + api_response = api_instance.import_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) /sources/{sourceId}/upload-connector-file: post: operationId: importConnectorFile @@ -43246,6 +50831,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-connector-file + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) /sources/{id}/correlation-config: get: operationId: getCorrelationConfig @@ -43281,14 +50882,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 @@ -43365,6 +50969,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-correlation-config + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + api_response = api_instance.get_correlation_config(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_correlation_config(id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) put: operationId: putCorrelationConfig tags: @@ -43461,6 +51080,42 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-correlation-config + source: | + 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 + Result = correlation_config.from_json(correlation_config) + api_response = api_instance.put_correlation_config(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_correlation_config(id, Result) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) /sources/{sourceId}/password-policies: patch: operationId: updatePasswordPolicyHolders @@ -43580,6 +51235,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-password-policy-holders + source: | + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + password_policy_holders_dto_inner = [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | + + try: + # Update Password Policy + Result = password_policy_holders_dto_inner.from_json(password_policy_holders_dto_inner) + api_response = api_instance.update_password_policy_holders(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_policy_holders(source_id, Result) + print("The response of SourcesApi->update_password_policy_holders:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) /tagged-objects: get: operationId: listTaggedObjects @@ -43696,6 +51369,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) post: operationId: setTagToObject security: @@ -43760,6 +51451,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) /tagged-objects/{type}: get: operationId: listTaggedObjectsByType @@ -43857,6 +51568,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) /tagged-objects/{type}/{id}: get: operationId: getTaggedObject @@ -43934,6 +51664,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) put: operationId: putTaggedObject security: @@ -44027,6 +51773,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) delete: operationId: deleteTaggedObject security: @@ -44097,6 +51867,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -44219,6 +52003,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tags-to-many-objects + source: | + 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 + Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) /tagged-objects/bulk-remove: post: operationId: deleteTagsToManyObject @@ -44310,6 +52121,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tags-to-many-object + source: | + 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 + Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) /transforms: get: tags: @@ -44433,6 +52268,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) post: tags: - Transforms @@ -44644,6 +52498,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) /transforms/{id}: get: tags: @@ -44711,6 +52584,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) put: tags: - Transforms @@ -44820,6 +52708,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) delete: tags: - Transforms @@ -44881,6 +52789,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) /work-items: get: operationId: listWorkItems @@ -45034,6 +52955,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) /work-items/completed: get: operationId: getCompletedWorkItems @@ -45100,6 +53039,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items + source: | + 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) /work-items/count: get: operationId: getCountWorkItems @@ -45159,6 +53116,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items + source: | + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) /work-items/completed/count: get: operationId: getCountCompletedWorkItems @@ -45187,10 +53159,8 @@ 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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/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 @@ -45218,6 +53188,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-items + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) /work-items/summary: get: operationId: getWorkItemsSummary @@ -45285,6 +53271,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) /work-items/{id}: get: operationId: getWorkItem @@ -45341,6 +53342,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) post: operationId: completeWorkItem tags: @@ -45399,6 +53415,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) /work-items/{id}/approve/{approvalItemId}: post: operationId: approveApprovalItem @@ -45466,6 +53497,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) /work-items/{id}/reject/{approvalItemId}: post: operationId: rejectApprovalItem @@ -45533,6 +53580,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) /work-items/bulk-approve/{id}: post: operationId: approveApprovalItemsInBulk @@ -45592,6 +53655,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + 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 @@ -45651,6 +53729,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + 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 @@ -45722,6 +53815,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) /workflows: get: operationId: listWorkflows @@ -45834,6 +53943,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) post: operationId: createWorkflow tags: @@ -46148,6 +54271,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) /workflows/{id}: get: operationId: getWorkflow @@ -46208,6 +54346,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) put: operationId: putWorkflow tags: @@ -46316,6 +54469,60 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow + source: | + 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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.put_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_workflow(id, Result) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) patch: operationId: patchWorkflow tags: @@ -46433,6 +54640,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) delete: operationId: deleteWorkflow tags: @@ -46488,6 +54717,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) /workflows/{id}/test: post: operationId: testWorkflow @@ -46596,6 +54838,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) /workflows/{id}/executions: get: operationId: getWorkflowExecutions @@ -46727,6 +54985,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions + source: | + 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 + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) /workflow-executions/{id}: get: operationId: getWorkflowExecution @@ -46791,6 +55068,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) /workflow-executions/{id}/history: get: operationId: getWorkflowExecutionHistory @@ -46886,6 +55178,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) /workflow-executions/{id}/cancel: post: operationId: cancelWorkflowExecution @@ -46945,6 +55252,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) /workflow-library: get: operationId: listCompleteWorkflowLibrary @@ -47334,6 +55654,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) /workflow-library/actions: get: operationId: listWorkflowLibraryActions @@ -47408,6 +55744,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) /workflow-library/triggers: get: operationId: listWorkflowLibraryTriggers @@ -47482,6 +55835,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) /workflow-library/operators: get: operationId: listWorkflowLibraryOperators @@ -47533,6 +55903,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) /workflows/{id}/external/oauth-clients: post: operationId: createWorkflowExternalTrigger @@ -47605,6 +55989,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.create_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) /workflows/execute/external/{id}: post: operationId: createExternalExecuteWorkflow @@ -47689,6 +56088,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = sailpoint.v2024.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.create_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) /workflows/execute/external/{id}/test: post: operationId: testExternalExecuteWorkflow @@ -47769,6 +56184,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.v2024.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) /source-usages/{sourceId}/status: get: tags: @@ -47840,6 +56271,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) /source-usages/{sourceId}/summaries: get: tags: @@ -47931,6 +56377,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) /account-usages/{accountId}/summaries: get: tags: @@ -48022,6 +56487,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) /identity-profiles/identity-preview: post: operationId: generateIdentityPreview @@ -48168,6 +56652,48 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-profiles#generate-identity-preview + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) + print("The response of IdentityProfilesApi->generate_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) /work-items/{id}/forward: post: operationId: forwardWorkItem @@ -48259,6 +56785,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item + source: | + 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 + Result = work_item_forward.from_json(work_item_forward) + api_instance.forward_work_item(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.forward_work_item(id, x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) /accounts/search-attribute-config: post: operationId: createSearchAttributeConfig @@ -48356,6 +56901,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#create-search-attribute-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) get: operationId: getSearchAttributeConfig tags: @@ -48414,6 +56982,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-search-attribute-config + source: | + x_sail_point_experimental = 'true' # 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 Extended Search Attributes + + api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + 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,10 +57030,8 @@ 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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/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 @@ -48487,6 +57068,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + 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 + + api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) delete: operationId: deleteSearchAttributeConfig tags: @@ -48550,6 +57147,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -48650,6 +57261,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#patch-search-attribute-config + source: | + 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') + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + 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 @@ -48770,6 +57404,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(api_response) + 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 @@ -48838,6 +57488,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + 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 + + api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(api_response) + 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 @@ -48920,6 +57586,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + 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 + + api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(api_response) + 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 @@ -48997,6 +57679,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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 + + api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + pprint(api_response) + 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 @@ -49152,6 +57851,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-profiles#update-access-profiles-in-bulk + source: | + x_sail_point_experimental = 'true' # 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=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | + + try: + # Update Access Profile(s) requestable field. + Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) + api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) /access-requests/close: post: operationId: closeAccessRequest @@ -49273,6 +57990,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#close-access-request + source: | + x_sail_point_experimental = 'true' # 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 + Result = close_access_request.from_json(close_access_request) + api_response = api_instance.close_access_request(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.close_access_request(x_sail_point_experimental, Result) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) /ai-access-request-recommendations: get: operationId: getAccessRequestRecommendations @@ -49465,6 +58203,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 + + api_response = api_instance.get_access_request_recommendations(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) /ai-access-request-recommendations/config: get: operationId: getAccessRequestRecommendationsConfig @@ -49554,6 +58314,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) put: operationId: setAccessRequestRecommendationsConfig tags: @@ -49633,6 +58408,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = access_request_recommendation_config_dto.from_json(access_request_recommendation_config_dto) + api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") + pprint(api_response) + 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 @@ -49738,6 +58536,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Ignored Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsIgnoredItems tags: @@ -49831,6 +58651,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + x_sail_point_experimental = 'true' # 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 of Ignored Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_ignored_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -49905,6 +58745,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Requested Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsRequestedItems tags: @@ -49997,6 +58859,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 of Requested Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_requested_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -50071,6 +58953,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + x_sail_point_experimental = 'true' # 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: + # Notification of Viewed Access Request Recommendations + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsViewedItems tags: @@ -50163,6 +59067,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + x_sail_point_experimental = 'true' # 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 = '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: **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 of Viewed Access Request Recommendations + + api_response = api_instance.get_access_request_recommendations_viewed_items(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -50240,6 +59164,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + access_request_recommendation_action_item_dto = { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + + try: + # Notification of Viewed Access Request Recommendations in Bulk + Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) + api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) /accounts/{id}/remove: post: operationId: deleteAccountAsync @@ -50318,6 +59266,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account-async + source: | + 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 + + api_response = api_instance.delete_account_async(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account_async(id, x_sail_point_experimental) + print("The response of AccountsApi->delete_account_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) /identities-accounts/{id}/enable: post: operationId: enableAccountForIdentity @@ -50388,6 +59352,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account-for-identity + source: | + 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 + + api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) /identities-accounts/{id}/disable: post: operationId: disableAccountForIdentity @@ -50458,6 +59438,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account-for-identity + source: | + 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 + + api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) /identities-accounts/enable: post: operationId: enableAccountsForIdentities @@ -50564,6 +59560,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#enable-accounts-for-identities + source: | + x_sail_point_experimental = 'true' # 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 + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) /identities-accounts/disable: post: operationId: disableAccountsForIdentities @@ -50648,6 +59662,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/accounts#disable-accounts-for-identities + source: | + x_sail_point_experimental = 'true' # 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 + Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) + api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(api_response) + 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 +59729,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 +59741,7 @@ paths: - CANCELLED - RETRIED - TERMINATED + - NOT_FOUND example: ACCOUNTS_COLLECTED description: | STARTED - Aggregation started, but source account iteration has not completed. @@ -50762,12 +59796,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/account-aggregations#get-account-aggregation-status + source: | + 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 + + api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(api_response) + 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,16 +59828,18 @@ 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 @@ -50818,7 +59870,7 @@ paths: 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 @@ -50829,12 +59881,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config-list + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_profile_config_list(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config_list(x_sail_point_experimental) + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(api_response) + 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 +59930,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: @@ -50925,7 +59994,7 @@ paths: $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 @@ -50936,6 +60005,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_profile_config(x_sail_point_experimental, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_profile_config(x_sail_point_experimental, id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) patch: operationId: patchProfileConfig tags: @@ -51021,6 +60106,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/auth-profile#patch-profile-config + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Auth Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) /connector-rules: get: tags: @@ -51115,6 +60223,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule-list + source: | + x_sail_point_experimental = 'true' # 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: + # List Connector Rules + + api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, limit, offset, count) + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) post: tags: - Connector Rule Management @@ -51142,6 +60268,7 @@ paths: maxLength: 128 description: type: string + nullable: true description: a description of the rule's purpose example: This rule does that type: @@ -51161,6 +60288,7 @@ paths: - PeopleSoftHRMSOperationProvisioning - PeopleSoftHRMSProvision - RACFPermissionCustomization + - ResourceObjectCustomization - SAPBuildMap - SapHrManagerRule - SapHrOperationProvisioning @@ -51188,6 +60316,7 @@ paths: example: firstName description: type: string + nullable: true description: the description of the argument example: the first name of the identity type: @@ -51291,6 +60420,47 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#create-connector-rule + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_create_request = { + "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" + } # ConnectorRuleCreateRequest | Connector rule to create. + try: + # Create Connector Rule + Result = connector_rule_create_request.from_json(connector_rule_create_request) + api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) /connector-rules/{id}: get: tags: @@ -51367,6 +60537,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule 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 Connector Rule + + api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) put: tags: - Connector Rule Management @@ -51487,6 +60673,49 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#put-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + connector_rule_update_request = { + "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" + } # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + try: + # Update Connector Rule + + api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) delete: tags: - Connector Rule Management @@ -51557,6 +60786,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#delete-connector-rule + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule 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 Connector Rule + + api_instance.delete_connector_rule(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.delete_connector_rule(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) /connector-rules/validate: post: tags: @@ -51678,6 +60921,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#test-connector-rule + source: | + x_sail_point_experimental = 'true' # 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_code = { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } # SourceCode | Code to validate. + try: + # Validate Connector Rule + Result = source_code.from_json(source_code) + api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) + print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) /custom-password-instructions: post: operationId: createCustomPasswordInstructions @@ -51782,6 +61044,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#create-custom-password-instructions + source: | + x_sail_point_experimental = 'true' # 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 + Result = custom_password_instruction.from_json(custom_password_instruction) + api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) /custom-password-instructions/{pageId}: get: operationId: getCustomPasswordInstructions @@ -51870,6 +61152,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#get-custom-password-instructions + source: | + 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 + + api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) delete: operationId: deleteCustomPasswordInstructions tags: @@ -51949,6 +61248,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#delete-custom-password-instructions + source: | + 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 + + api_instance.delete_custom_password_instructions(page_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -52110,6 +61424,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlements + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.list_entitlements(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) /entitlements/{id}: get: operationId: getEntitlement @@ -52214,6 +61552,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement + source: | + 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 + + api_response = api_instance.get_entitlement(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) patch: operationId: patchEntitlement tags: @@ -52362,6 +61716,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#patch-entitlement + source: | + 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') + [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch an entitlement + + api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, Result) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) /entitlements/{id}/parents: get: operationId: listEntitlementParents @@ -52522,6 +61899,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-parents + source: | + 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 + + api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) /entitlements/{id}/children: get: operationId: listEntitlementChildren @@ -52681,6 +62079,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-children + source: | + 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 + + api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) /entitlements/bulk-update: post: operationId: updateEntitlementsInBulk @@ -52718,56 +62137,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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml example: - op: replace path: /privileged @@ -52850,6 +62221,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#update-entitlements-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) + api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) /entitlements/{id}/entitlement-request-config: get: operationId: getEntitlementRequestConfig @@ -52959,6 +62355,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement-request-config + source: | + 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 + + api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) put: operationId: putEntitlementRequestConfig tags: @@ -53058,6 +62470,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#put-entitlement-request-config + source: | + 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 + Result = entitlement_request_config.from_json(entitlement_request_config) + api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) /entitlements/reset/sources/{id}: post: operationId: resetSourceEntitlements @@ -53140,6 +62574,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#reset-source-entitlements + source: | + 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 + + api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(api_response) + 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. @@ -53226,6 +62676,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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. + + api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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. @@ -53306,6 +62774,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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. + + api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -53441,6 +62925,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/entitlements#import-entitlements-by-source + source: | + 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 + + api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) /generate-password-reset-token/digit: post: operationId: createDigitToken @@ -53544,6 +63045,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/password-management#create-digit-token + source: | + x_sail_point_experimental = 'true' # 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 + Result = password_digit_token_reset.from_json(password_digit_token_reset) + api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) /historical-identities: get: operationId: listHistoricalIdentities @@ -53660,6 +63181,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-historical-identities + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_historical_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) /historical-identities/{id}: get: operationId: getHistoricalIdentity @@ -53766,6 +63307,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity + source: | + 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 + + api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) /historical-identities/{id}/access-items: get: operationId: listIdentityAccessItems @@ -54099,6 +63656,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-access-items + source: | + 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 + + api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) /historical-identities/{id}/snapshots: get: operationId: listIdentitySnapshots @@ -54195,6 +63772,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshots + source: | + 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 + + api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) /historical-identities/{id}/snapshot-summary: get: operationId: getIdentitySnapshotSummary @@ -54303,6 +63901,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot-summary + source: | + 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 + + api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) /historical-identities/{id}/snapshots/{date}: get: operationId: getIdentitySnapshot @@ -54376,6 +63996,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot + source: | + 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 + + api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(api_response) + 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 @@ -54515,6 +64152,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshot-access-items + source: | + 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 + + api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) /common-access: get: operationId: getCommonAccess @@ -54668,6 +64323,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#get-common-access + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_common_access(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) post: operationId: createCommonAccess summary: Create common access items @@ -54770,6 +64445,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#create-common-access + source: | + x_sail_point_experimental = 'true' # 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 + Result = common_access_item_request.from_json(common_access_item_request) + api_response = api_instance.create_common_access(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_common_access(x_sail_point_experimental, Result) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) /common-access/update-status: post: operationId: updateCommonAccessStatusInBulk @@ -54850,6 +64551,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-common-access#update-common-access-status-in-bulk + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + common_access_id_status = { + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + try: + # Bulk update common access status + Result = common_access_id_status.from_json(common_access_id_status) + api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + pprint(api_response) + 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 @@ -55450,6 +65172,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity-events + source: | + 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) + + 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) + + 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 + + api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) /historical-identities/{id}/start-date: get: operationId: getIdentityStartDate @@ -55515,6 +65263,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-start-date + source: | + 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 + + api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) /historical-identities/{id}/compare: get: operationId: compareIdentitySnapshots @@ -55631,6 +65395,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots + source: | + 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) + + 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 + + api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) /historical-identities/{id}/compare/{access-type}: get: operationId: compareIdentitySnapshotsAccessType @@ -55761,6 +65549,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 + + api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) /identities/{identityId}/synchronize-attributes: post: operationId: synchronizeAttributesForIdentity @@ -55870,6 +65681,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#synchronize-attributes-for-identity + source: | + 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. + + api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) /identities/{identityId}/ownership: get: operationId: getIdentityOwnershipDetails @@ -55986,6 +65813,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-identity-ownership-details + source: | + 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 + + api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) /identities: get: operationId: listIdentities @@ -56232,6 +66075,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#list-identities + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) /identities/{id}: get: operationId: getIdentity @@ -56304,6 +66168,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-identity + source: | + 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 + + api_response = api_instance.get_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity(id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) delete: operationId: deleteIdentity tags: @@ -56406,6 +66286,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#delete-identity + source: | + 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 + + api_instance.delete_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -56725,6 +66619,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#start-identities-invite + source: | + x_sail_point_experimental = 'true' # 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 + Result = invite_identities_request.from_json(invite_identities_request) + api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) /identities/{id}/verification/account/send: post: operationId: sendIdentityVerificationAccountToken @@ -56823,6 +66736,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#send-identity-verification-account-token + source: | + x_sail_point_experimental = 'true' # 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 + Result = send_account_verification_request.from_json(send_account_verification_request) + api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) /identities/process: post: operationId: startIdentityProcessing @@ -56932,6 +66863,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#start-identity-processing + source: | + x_sail_point_experimental = 'true' # 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 + Result = process_identities_request.from_json(process_identities_request) + api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) /identities/{id}/reset: post: operationId: resetIdentity @@ -56998,6 +66947,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#reset-identity + source: | + 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 + + api_instance.reset_identity(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -57078,6 +67041,7 @@ paths: x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/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 +67049,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 @@ -57103,60 +67079,74 @@ paths: $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 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: 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/allOf/0/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 + - 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: @@ -57191,6 +67181,7 @@ paths: example: Marketing removeDate: type: string + nullable: true description: Date that the assignment will be removed example: Wed Feb 14 10:58:42 '400': @@ -57231,6 +67222,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignments + source: | + 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 + + api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) /identities/{identityId}/role-assignments/{assignmentId}: get: operationId: getRoleAssignment @@ -57310,6 +67319,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignment + source: | + 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 + + api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) /identity-attributes: get: operationId: listIdentityAttributes @@ -57452,6 +67478,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#list-identity-attributes + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_identity_attributes(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) post: operationId: createIdentityAttribute tags: @@ -57545,6 +67590,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#create-identity-attribute + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) /identity-attributes/{name}: get: operationId: getIdentityAttribute @@ -57616,6 +67698,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#get-identity-attribute + source: | + 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 + + api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) put: operationId: putIdentityAttribute tags: @@ -57718,6 +67816,44 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#put-identity-attribute + source: | + 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 + Result = identity_attribute.from_json(identity_attribute) + api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) delete: operationId: deleteIdentityAttribute tags: @@ -57784,6 +67920,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attribute + source: | + 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 + + api_instance.delete_identity_attribute(name, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -57865,6 +68015,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + Result = identity_attribute_names.from_json(identity_attribute_names) + api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) /mail-from-attributes: put: security: @@ -57975,6 +68141,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#put-mail-from-attributes + source: | + x_sail_point_experimental = 'true' # 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 + Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) + api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) /mail-from-attributes/{identity}: get: security: @@ -58042,6 +68227,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-mail-from-attributes + source: | + 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 + + api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) /generic-approvals: get: security: @@ -58293,6 +68494,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/approvals#get-approvals + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_approvals(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approvals(x_sail_point_experimental, mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) /generic-approvals/{id}: get: security: @@ -58361,6 +68580,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/approvals#get-approval + source: | + 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 + + api_response = api_instance.get_approval(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_approval(id, x_sail_point_experimental) + print("The response of ApprovalsApi->get_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) /machine-accounts: get: operationId: listMachineAccounts @@ -58594,6 +68829,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#list-machine-accounts + source: | + x_sail_point_experimental = 'true' # 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* **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) # 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* **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) + 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 + + api_response = api_instance.list_machine_accounts(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of MachineAccountsApi->list_machine_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) /machine-accounts/{id}: get: operationId: getMachineAccount @@ -58670,6 +68925,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#get-machine-account + source: | + 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 + + api_response = api_instance.get_machine_account(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_machine_account(id, x_sail_point_experimental) + print("The response of MachineAccountsApi->get_machine_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) patch: operationId: updateMachineAccount tags: @@ -58773,6 +69044,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-accounts#update-machine-account + source: | + 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. + 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. + + try: + # Update a Machine Account + Result = request_body.from_json(request_body) + api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) + print("The response of MachineAccountsApi->update_machine_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) /machine-identities: get: operationId: listMachineIdentities @@ -58886,6 +69176,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#list-machine-identities + source: | + x_sail_point_experimental = 'true' # 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 = '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 + + api_response = api_instance.list_machine_identities(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset) + print("The response of MachineIdentitiesApi->list_machine_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) post: operationId: createMachineIdentity tags: @@ -58971,6 +69280,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#create-machine-identity + source: | + x_sail_point_experimental = 'true' # 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 + Result = machine_identity.from_json(machine_identity) + api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) + print("The response of MachineIdentitiesApi->create_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) /machine-identities/{id}: get: operationId: getMachineIdentity @@ -59047,6 +69381,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#get-machine-identity + source: | + 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 + + api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) + print("The response of MachineIdentitiesApi->get_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) patch: operationId: updateMachineIdentity tags: @@ -59148,6 +69498,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#update-machine-identity + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) + print("The response of MachineIdentitiesApi->update_machine_identity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) delete: operationId: deleteMachineIdentity tags: @@ -59216,6 +69585,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/machine-identities#delete-machine-identity + source: | + 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 + + api_instance.delete_machine_identity(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -59486,6 +69869,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-template-defaults + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) /notification-templates: get: operationId: listNotificationTemplates @@ -59647,6 +70048,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-templates + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_notification_templates(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_templates(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) post: operationId: createNotificationTemplate tags: @@ -59736,6 +70155,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-notification-template + source: | + x_sail_point_experimental = 'true' # 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 + Result = template_dto.from_json(template_dto) + api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) /notification-templates/{id}: get: operationId: getNotificationTemplate @@ -59768,10 +70220,8 @@ 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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/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 @@ -59805,6 +70255,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-notification-template + source: | + 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 + + api_response = api_instance.get_notification_template(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notification_template(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) /notification-templates/bulk-delete: post: operationId: deleteNotificationTemplatesInBulk @@ -59892,6 +70358,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#delete-notification-templates-in-bulk + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | + template_bulk_delete_dto = { + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + } # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) + api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) /org-config: get: operationId: getOrgConfig @@ -60031,6 +70517,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#get-org-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_org_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_org_config(x_sail_point_experimental) + print("The response of OrgConfigApi->get_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) patch: operationId: patchOrgConfig tags: @@ -60115,6 +70616,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#patch-org-config + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) /org-config/valid-time-zones: get: operationId: getValidTimeZones @@ -60196,6 +70719,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/org-config#get-valid-time-zones + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, limit, offset, count) + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) /outlier-summaries: get: operationId: getIdentityOutlierSnapshots @@ -60338,6 +70879,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outlier-snapshots + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) /outlier-summaries/latest: get: operationId: getLatestIdentityOutlierSnapshots @@ -60444,6 +71005,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) /outliers: get: operationId: getIdentityOutliers @@ -60632,6 +71209,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_identity_outliers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) /outliers/{outlierId}/contributing-features: get: operationId: getPeerGroupOutliersContributingFeatures @@ -60711,28 +71309,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,6 +71347,7 @@ 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' @@ -60802,6 +71406,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + 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 + + api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -60888,6 +71513,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 @@ -60958,6 +71584,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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 + + api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) /outliers/ignore: post: operationId: ignoreIdentityOutliers @@ -61034,6 +71682,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#ignore-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Ignore + Result = request_body.from_json(request_body) + api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) /outliers/unignore: post: operationId: unIgnoreIdentityOutliers @@ -61110,6 +71774,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#un-ignore-identity-outliers + source: | + x_sail_point_experimental = 'true' # 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] | + request_body = ['request_body_example'] # List[str] | + + try: + # IAI Identity Outliers Unignore + Result = request_body.from_json(request_body) + api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) /outliers/export: get: operationId: exportOutliersZip @@ -61190,6 +71870,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#export-outliers-zip + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.export_outliers_zip(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_outliers_zip(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) /outlier-feature-summaries/{outlierFeatureId}: get: operationId: getOutlierContributingFeatureSummary @@ -61252,12 +71948,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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/OutlierValueType featureDefinition: type: string description: Definition of the feature @@ -61268,10 +71960,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: @@ -61326,6 +72020,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + 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 + + api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(api_response) + 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 @@ -61420,6 +72130,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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 + + api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) /notification-template-context: get: operationId: getNotificationsTemplateContext @@ -61507,6 +72236,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-notifications-template-context + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_notifications_template_context(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_notifications_template_context(x_sail_point_experimental) + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) /notification-preferences/{key}: get: operationId: listNotificationPreferences @@ -61523,33 +72267,31 @@ 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 @@ -61594,6 +72336,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-preferences + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.list_notification_preferences(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_notification_preferences(x_sail_point_experimental) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) /reassignment-configurations/types: get: operationId: getReassignmentConfigTypes @@ -61678,6 +72435,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) /reassignment-configurations: get: operationId: listReassignmentConfigurations @@ -61781,6 +72553,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) post: operationId: createReassignmentConfiguration tags: @@ -61889,6 +72676,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + x_sail_point_experimental = 'true' # 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) /reassignment-configurations/{identityId}: get: operationId: getReassignmentConfiguration @@ -61960,6 +72769,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration + source: | + 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 + + api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) put: operationId: putReassignmentConfig tags: @@ -62044,6 +72869,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config + source: | + 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 + Result = configuration_item_request.from_json(configuration_item_request) + api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) /reassignment-configurations/{identityId}/{configType}: delete: operationId: deleteReassignmentConfiguration @@ -62119,6 +72967,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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 + + api_instance.delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -62279,6 +73142,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2024.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) + + 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 + + api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) /reassignment-configurations/tenant-config: get: operationId: getTenantConfigConfiguration @@ -62372,6 +73255,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-configuration + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) put: operationId: putTenantConfiguration tags: @@ -62449,6 +73347,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration + source: | + x_sail_point_experimental = 'true' # 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 + Result = tenant_configuration_request.from_json(tenant_configuration_request) + api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) /recommendations/request: post: operationId: getRecommendations @@ -62667,6 +73585,40 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations + source: | + x_sail_point_experimental = 'true' # 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 a Recommendation Based on Object + Result = recommendation_request_dto.from_json(recommendation_request_dto) + api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) /recommendations/config: get: operationId: getRecommendationsConfig @@ -62750,6 +73702,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_recommendations_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_recommendations_config(x_sail_point_experimental) + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) put: operationId: updateRecommendationsConfig summary: Update certification recommendation config values @@ -62820,6 +73787,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#update-recommendations-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = recommendation_config_dto.from_json(recommendation_config_dto) + api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) /role-insights/requests: post: operationId: createRoleInsightRequests @@ -62918,6 +73906,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#create-role-insight-requests + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.create_role_insight_requests(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_insight_requests(x_sail_point_experimental) + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) /role-insights/requests/{id}: get: operationId: getRoleInsightsRequests @@ -62984,6 +73987,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-requests + source: | + 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. + + api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) /role-insights/summary: get: operationId: getRoleInsightsSummary @@ -63061,6 +74080,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-summary + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_insights_summary(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_summary(x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) /role-insights: get: operationId: getRoleInsights @@ -63220,6 +74254,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_insights(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) /role-insights/{insightId}: get: operationId: getRoleInsight @@ -63282,6 +74336,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insight + source: | + 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 + + api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) /role-insights/{insightId}/entitlement-changes: get: operationId: getRoleInsightsEntitlementsChanges @@ -63346,21 +74416,28 @@ 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 @@ -63396,6 +74473,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-entitlements-changes + source: | + 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 + + api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + pprint(api_response) + 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 @@ -63489,6 +74584,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#download-role-insights-entitlements-changes + source: | + 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 + + api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + pprint(api_response) + 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,28 +74655,28 @@ 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 @@ -63595,6 +74708,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-current-entitlements + source: | + 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 + + api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(api_response) + 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 @@ -63733,6 +74863,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/role-insights#get-entitlement-changes-identities + source: | + 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) + + api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) /role-mining-sessions: post: operationId: createRoleMiningSessions @@ -64033,6 +75186,53 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-role-mining-sessions + source: | + x_sail_point_experimental = 'true' # 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 + Result = role_mining_session_dto.from_json(role_mining_session_dto) + api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(api_response) + 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 @@ -64124,6 +75324,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-sessions + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) /role-mining-sessions/{sessionId}: patch: operationId: patchRoleMiningSession @@ -64221,6 +75441,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-role-mining-session + source: | + 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') + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(api_response) + 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 @@ -64288,6 +75531,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session + source: | + 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 + + api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) /role-mining-sessions/{sessionId}/status: get: operationId: getRoleMiningSessionStatus @@ -64361,6 +75620,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session-status + source: | + 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 + + api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(api_response) + 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 @@ -64487,6 +75762,7 @@ paths: - PENDING - COMPLETE - FAILED + - null example: POTENTIAL roleId: type: string @@ -64632,6 +75908,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-summaries + source: | + 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 + + api_response = api_instance.get_potential_role_summaries(session_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -64728,8 +76025,7 @@ paths: type: array items: type: object - additionalProperties: - type: string + additionalProperties: true example: - attributeValue: NM Tier 3 count: 6 @@ -64746,8 +76042,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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRoleProvisionState.yaml + - description: The provisioning state of a potential role. + nullable: true quality: type: integer description: The quality of a potential role. @@ -64814,6 +76113,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role + source: | + 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 + + api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) patch: operationId: patchPotentialRole summary: Update a potential role @@ -64941,6 +76257,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role + source: | + 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') + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(api_response) + 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 @@ -65054,6 +76390,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-applications + source: | + 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 + + api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -65167,6 +76524,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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 + + api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -65355,6 +76733,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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 + + api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -65436,6 +76837,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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 + + api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -65535,6 +76954,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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 + Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) + api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(api_response) + 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 @@ -65611,21 +77051,21 @@ 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 @@ -65662,6 +77102,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-identities-potential-role + source: | + 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 + + api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -65733,6 +77195,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -65847,6 +77326,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(api_response) + 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 @@ -65930,6 +77430,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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 + + api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -66013,6 +77531,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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 + + api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -66147,6 +77683,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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. + + api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, Result) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(api_response) + 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 @@ -66259,6 +77821,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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 + + api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) /role-mining-potential-roles: get: operationId: getAllPotentialRoleSummaries @@ -66381,6 +77965,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-all-potential-role-summaries + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_all_potential_role_summaries(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -66448,6 +78052,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-potential-role + source: | + 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 + + api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(api_response) + 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 @@ -66577,6 +78197,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role-0 + source: | + 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') + [{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] | + 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 + Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) + api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result) + print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) /role-mining-potential-roles/saved: get: operationId: getSavedPotentialRoles @@ -66709,6 +78349,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-saved-potential-roles + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(api_response) + 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 @@ -66824,6 +78483,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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 + + api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) /roles/{id}/entitlements: get: operationId: getRoleEntitlements @@ -66954,6 +78634,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-role-entitlements + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing 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') + 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* (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 + + api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) /send-test-notification: post: operationId: sendTestNotification @@ -67044,6 +78745,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#send-test-notification + source: | + x_sail_point_experimental = 'true' # 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 + Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) + api_instance.send_test_notification(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_test_notification(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) /sim-integrations/{id}: put: tags: @@ -67114,39 +78833,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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/DtoType.yaml id: type: string description: ID of the rule @@ -67243,6 +78931,40 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration + source: | + 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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) get: tags: - SIM Integrations @@ -67315,6 +79037,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration + source: | + 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. + + api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) delete: tags: - SIM Integrations @@ -67382,6 +79120,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration + source: | + 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 + + api_instance.delete_sim_integration(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -67483,6 +79235,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes + source: | + 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. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) /sim-integrations/{id}/beforeProvisioningRule: patch: tags: @@ -67578,6 +79357,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + 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. + Result = json_patch.from_json(json_patch) + api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) /sim-integrations: get: tags: @@ -67591,8 +79397,10 @@ 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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/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 @@ -67642,6 +79450,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations + source: | + x_sail_point_experimental = 'true' # 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. + + api_response = api_instance.get_sim_integrations(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) post: tags: - SIM Integrations @@ -67734,6 +79557,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration + source: | + x_sail_point_experimental = 'true' # 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 + Result = sim_integration_details.from_json(sim_integration_details) + api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) /sp-config/export: post: operationId: exportSpConfig @@ -67981,6 +79837,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config + source: | + export_payload = { + "description" : "Export Job 1 Test" + } # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + Result = export_payload.from_json(export_payload) + api_response = api_instance.export_sp_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_sp_config(Result) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) /sp-config/export/{id}: get: operationId: getSpConfigExportStatus @@ -68068,6 +79941,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status + source: | + 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 + + api_response = api_instance.get_sp_config_export_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(api_response) + 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 @@ -68302,6 +80190,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export + source: | + 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. + + api_response = api_instance.get_sp_config_export(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) /sp-config/import: post: operationId: importSpConfig @@ -68539,6 +80442,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config + source: | + 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 + + api_response = api_instance.import_sp_config(data, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) /sp-config/import/{id}: get: operationId: getSpConfigImportStatus @@ -68633,6 +80553,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status + source: | + 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 + + api_response = api_instance.get_sp_config_import_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(api_response) + 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 @@ -68800,6 +80735,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import + source: | + 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 + + api_response = api_instance.get_sp_config_import(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) /sp-config/config-objects: get: operationId: listSpConfigObjects @@ -68943,6 +80893,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects + source: | + try: + # Get config object details + + api_response = api_instance.list_sp_config_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(api_response) + 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 +80966,7 @@ paths: example: 2c9180835d191a86015d28455b4b232a name: type: string + nullable: true description: Human-readable name of target source for attribute synchronization. example: HR Active Directory attributes: @@ -69077,6 +81042,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-attr-sync-config + source: | + 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 + + api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) put: operationId: putSourceAttrSyncConfig tags: @@ -69178,6 +81159,40 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-source-attr-sync-config + source: | + 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 + Result = attr_sync_source_config.from_json(attr_sync_source_config) + api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) /sources/{sourceId}/connector/check-connection: post: operationId: testSourceConnection @@ -69301,6 +81316,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#test-source-connection + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + x_sail_point_experimental = 'true' # 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: + # Check connection for source connector. + + api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_connection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) /sources/{sourceId}/connector/peek-resource-objects: post: operationId: peekResourceObjects @@ -69501,6 +81532,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#peek-resource-objects + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + resource_objects_request = { + "maxCount" : 100, + "objectType" : "group" + } # ResourceObjectsRequest | + try: + # Peek source connector's resource objects + Result = resource_objects_request.from_json(resource_objects_request) + api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) /sources/{sourceId}/connector/ping-cluster: post: operationId: pingCluster @@ -69574,6 +81625,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#ping-cluster + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # 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: + # Ping cluster for source connector + + api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + print("The response of SourcesApi->ping_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) /sources/{sourceId}/connector/test-configuration: post: operationId: testSourceConfiguration @@ -69647,6 +81714,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#test-source-configuration + source: | + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + x_sail_point_experimental = 'true' # 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: + # Test configuration for source connector + + api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) /sources/{id}/connectors/source-config: get: operationId: getSourceConfig @@ -69741,6 +81824,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-config + source: | + 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') + locale = 'locale_example' # 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 + + api_response = api_instance.get_source_config(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_config(id, x_sail_point_experimental, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) /sources/{sourceId}/native-change-detection-config: get: operationId: getNativeChangeDetectionConfig @@ -69863,6 +81963,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-native-change-detection-config + source: | + 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 + + api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) put: operationId: putNativeChangeDetectionConfig tags: @@ -69953,6 +82069,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#put-native-change-detection-config + source: | + 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 + Result = native_change_detection_config.from_json(native_change_detection_config) + api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + print("The response of SourcesApi->put_native_change_detection_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) delete: operationId: deleteNativeChangeDetectionConfig tags: @@ -70023,6 +82163,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-native-change-detection-config + source: | + 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 + + api_instance.delete_native_change_detection_config(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -70101,6 +82255,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#delete-accounts-async + source: | + 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 + + api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) /sources/{id}/synchronize-attributes: post: operationId: syncAttributesForSource @@ -70210,6 +82380,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#sync-attributes-for-source + source: | + 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. + + api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) /sources/{id}/entitlement-request-config: get: security: @@ -70352,6 +82538,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#get-source-entitlement-request-config + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) put: security: - userAuth: @@ -70467,6 +82668,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#update-source-entitlement-request-config + source: | + x_sail_point_experimental = 'true' # 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 + Result = source_entitlement_request_config.from_json(source_entitlement_request_config) + api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) /sources/{id}/load-accounts: post: tags: @@ -70742,6 +82971,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts + source: | + 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 + + api_response = api_instance.import_accounts(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts(id, x_sail_point_experimental, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) /sources/{id}/load-uncorrelated-accounts: post: tags: @@ -70990,6 +83237,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/sources#import-uncorrelated-accounts + source: | + 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 + + api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) /task-status/{id}: get: tags: @@ -71074,6 +83338,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status + source: | + 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 + + api_response = api_instance.get_task_status(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status(id, x_sail_point_experimental) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) patch: operationId: updateTaskStatus tags: @@ -71178,6 +83458,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#update-task-status + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + + try: + # Update Task Status by ID + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) /task-status: get: tags: @@ -71296,6 +83599,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status-list + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_task_status_list(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) /task-status/pending-tasks: get: tags: @@ -71382,6 +83705,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-tasks + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_pending_tasks(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_tasks(x_sail_point_experimental, offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) head: tags: - Task Management @@ -71460,6 +83801,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-task-headers + source: | + x_sail_point_experimental = 'true' # 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 + + api_instance.get_pending_task_headers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -71637,6 +83994,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/tenant#get-tenant + source: | + try: + # Get Tenant Information. + + api_response = api_instance.get_tenant() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) /triggers: get: operationId: listTriggers @@ -72830,70 +85201,11 @@ paths: - 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 + $ref: '#/components/schemas/Certification/properties/campaign' + x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CampaignReference.yaml 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 + $ref: '#/components/schemas/Certification/properties/phase' + x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertificationPhase.yaml due: type: string format: date-time @@ -73888,6 +86200,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-triggers + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_triggers(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) /trigger-subscriptions: post: operationId: createSubscription @@ -74201,6 +86533,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#create-subscription + source: | + x_sail_point_experimental = 'true' # 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 + Result = subscription_post_request.from_json(subscription_post_request) + api_response = api_instance.create_subscription(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_subscription(x_sail_point_experimental, Result) + print("The response of TriggersApi->create_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) get: operationId: listSubscriptions tags: @@ -74347,6 +86719,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-subscriptions + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_subscriptions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) /trigger-subscriptions/{id}: put: operationId: updateSubscription @@ -74539,6 +86931,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#update-subscription + source: | + 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 + Result = subscription_put_request.from_json(subscription_put_request) + api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) + print("The response of TriggersApi->update_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) patch: operationId: patchSubscription tags: @@ -74663,6 +87095,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#patch-subscription + source: | + 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') + [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + subscription_patch_request_inner = [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | + + try: + # Patch a Subscription + Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) + api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) + print("The response of TriggersApi->patch_subscription:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) delete: operationId: deleteSubscription tags: @@ -74729,6 +87180,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#delete-subscription + source: | + 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 + + api_instance.delete_subscription(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -74844,6 +87309,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#test-subscription-filter + source: | + x_sail_point_experimental = 'true' # 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 + Result = validate_filter_input_dto.from_json(validate_filter_input_dto) + api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) /trigger-invocations/status: get: operationId: listTriggerInvocationStatus @@ -75020,6 +87506,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#list-trigger-invocation-status + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) /trigger-invocations/{id}/complete: post: operationId: completeTriggerInvocation @@ -75118,6 +87624,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#complete-trigger-invocation + source: | + 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 + Result = complete_invocation.from_json(complete_invocation) + api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) /trigger-invocations/test: post: operationId: startTestTriggerInvocation @@ -75258,6 +87785,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/triggers#start-test-trigger-invocation + source: | + x_sail_point_experimental = 'true' # 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 + Result = test_invocation.from_json(test_invocation) + api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) /ui-metadata/tenant: get: operationId: getTenantUiMetadata @@ -75337,6 +87889,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/ui-metadata#get-tenant-ui-metadata + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental) + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) put: operationId: setTenantUiMetadata tags: @@ -75430,6 +87997,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/ui-metadata#set-tenant-ui-metadata + source: | + x_sail_point_experimental = 'true' # 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 + Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) + api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) /verified-from-addresses: get: operationId: listFromAddresses @@ -75532,6 +88119,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#list-from-addresses + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_from_addresses(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) post: operationId: createVerifiedFromAddress tags: @@ -75605,6 +88212,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-verified-from-address + source: | + x_sail_point_experimental = 'true' # 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 + Result = email_status_dto.from_json(email_status_dto) + api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) /verified-from-addresses/{id}: delete: operationId: deleteVerifiedFromAddress @@ -75667,6 +88295,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#delete-verified-from-address + source: | + 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 + + api_instance.delete_verified_from_address(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -75755,6 +88397,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#get-dkim-attributes + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.get_dkim_attributes(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_dkim_attributes(x_sail_point_experimental) + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) post: security: - userAuth: @@ -75873,6 +88530,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/notifications#create-domain-dkim + source: | + x_sail_point_experimental = 'true' # 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 + Result = domain_address.from_json(domain_address) + api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) /workgroups: get: operationId: listWorkgroups @@ -75934,23 +88609,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: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/OwnerDto.yaml - type: object properties: displayName: @@ -76037,6 +88697,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroups + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_workgroups(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) post: operationId: createWorkgroup security: @@ -76121,6 +88801,37 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#create-workgroup + source: | + x_sail_point_experimental = 'true' # 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. + Result = workgroup_dto.from_json(workgroup_dto) + api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) /workgroups/{id}: get: operationId: getWorkgroup @@ -76192,6 +88903,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#get-workgroup + source: | + 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 + + api_response = api_instance.get_workgroup(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workgroup(id, x_sail_point_experimental) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) delete: operationId: deleteWorkgroup tags: @@ -76258,6 +88985,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup + source: | + 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 + + api_instance.delete_workgroup(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -76353,6 +89094,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#patch-workgroup + source: | + 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') + [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch a Governance Group + + api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) /workgroups/bulk-delete: post: operationId: deleteWorkgroupsInBulk @@ -76487,6 +89251,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroups-in-bulk + source: | + x_sail_point_experimental = 'true' # 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) + Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) + api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) /workgroups/{workgroupId}/connections: get: operationId: listConnections @@ -76538,29 +89320,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 @@ -76609,6 +89396,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-connections + source: | + 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 + + api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) /workgroups/{workgroupId}/members: get: operationId: listWorkgroupMembers @@ -76718,6 +89525,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroup-members + source: | + 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 + + api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) /workgroups/{workgroupId}/members/bulk-add: post: operationId: updateWorkgroupMembers @@ -76858,6 +89685,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#update-workgroup-members + source: | + 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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + + try: + # Add members to Governance Group + Result = identity_preview_response_identity.from_json(identity_preview_response_identity) + api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) /workgroups/{workgroupId}/members/bulk-delete: post: operationId: deleteWorkgroupMembers @@ -76977,6 +89823,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup-members + source: | + 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') + [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + + try: + # Remove members from Governance Group + Result = identity_preview_response_identity.from_json(identity_preview_response_identity) + api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) /form-definitions: get: tags: @@ -77235,6 +90100,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-definitions-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 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. + + api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) post: tags: - Custom Forms @@ -77544,6 +90428,7 @@ paths: STRING FormDefinitionInputTypeString enum: - STRING + - ARRAY example: STRING type: string x-go-enum-desc: STRING FormDefinitionInputTypeString @@ -77945,6 +90830,132 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_definition(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) /form-definitions/{formDefinitionID}: get: tags: @@ -78122,6 +91133,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-definition-by-key + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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: + # Return a form definition. + + api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) delete: tags: - Custom Forms @@ -78299,6 +91326,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#delete-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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: + # Deletes a form definition. + + api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) patch: tags: - Custom Forms @@ -78504,6 +91547,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-definition + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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') + 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) + 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. + + api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, Result) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) /form-definitions/{formDefinitionID}/data-source: post: tags: @@ -78860,6 +91922,36 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#show-preview-data-source + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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 = 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. + + api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, limit, filters, query, Result) + print("The response of CustomFormsApi->show_preview_data_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) /form-definitions/export: get: tags: @@ -78959,7 +92051,7 @@ paths: x-go-name: Self version: type: integer - format: int8 + format: int32 x-go-name: Version '400': description: An error with the request occurred @@ -79084,6 +92176,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#export-form-definitions-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 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. + + api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + pprint(api_response) + 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: @@ -79332,6 +92443,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-dynamic-schema + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) /form-definitions/import: post: tags: @@ -79355,7 +92490,7 @@ paths: x-go-name: Self version: type: integer - format: int8 + format: int32 x-go-name: Version example: - version: 1 @@ -79448,7 +92583,7 @@ paths: x-go-name: Self version: type: integer - format: int8 + format: int32 x-go-name: Version x-go-name: ImportedObjects infos: @@ -79622,6 +92757,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#import-form-definitions + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + [{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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + 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[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional) + + try: + # Import form definitions from export. + + api_response = api_instance.import_form_definitions(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_form_definitions(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) /form-definitions/{formDefinitionID}/upload: post: tags: @@ -79906,6 +93059,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-file-request + source: | + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID + x_sail_point_experimental = 'true' # 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 | File specifying the multipart # bytearray | File specifying the multipart + try: + # Upload new form definition file. + + api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) /form-definitions/{formDefinitionID}/file/{fileID}: get: tags: @@ -80495,6 +93665,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-file-from-s3 + source: | + 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. + x_sail_point_experimental = 'true' # 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: + # Download definition file by fileId. + + api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) /form-instances: get: tags: @@ -80508,22 +93695,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: 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 '400': description: An error with the request occurred content: @@ -80652,6 +93841,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-instances-by-tenant + source: | + x_sail_point_experimental = 'true' # 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 form instances by tenant. + + api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental) + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) post: tags: - Custom Forms @@ -81066,6 +94270,42 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-instance + source: | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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. + + api_response = api_instance.create_form_instance(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_form_instance(x_sail_point_experimental, Result) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) /form-instances/{formInstanceID}: get: tags: @@ -81242,6 +94482,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-by-key + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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 a form instance. + + api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) patch: tags: - Custom Forms @@ -81462,6 +94718,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-instance + source: | + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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') + 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) + 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. + + api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, Result) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) /form-instances/{formInstanceID}/data-source/{formElementID}: get: tags: @@ -81707,6 +94982,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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 + x_sail_point_experimental = 'true' # 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 | 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. + + api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, limit, filters, query) + print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") + pprint(api_response) + 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: @@ -82296,6 +95591,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-file + source: | + 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. + x_sail_point_experimental = 'true' # 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: + # Download instance file by fileId. + + api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) /form-definitions/predefined-select-options: get: tags: @@ -82449,6 +95761,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-pre-defined-select-options + source: | + x_sail_point_experimental = 'true' # 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 predefined select options. + + api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental) + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(api_response) + 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: @@ -82575,6 +95902,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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 + + api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) /icons/{objectType}/{objectId}: put: operationId: setIcon @@ -82675,6 +96019,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/icons#set-icon + source: | + 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 + + api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image) + print("The response of IconsApi->set_icon:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) delete: operationId: deleteIcon tags: @@ -82751,6 +96113,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/icons#delete-icon + source: | + 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 + + api_instance.delete_icon(object_type, object_id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -82847,6 +96224,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + api_response = api_instance.get_sed_batch_stats(batch_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) /suggested-entitlement-description-batches: get: tags: @@ -82909,6 +96301,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batches + source: | + try: + # List Sed Batch Request + + api_response = api_instance.get_sed_batches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) post: tags: - Suggested Entitlement Description @@ -83000,6 +96406,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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 + + api_response = api_instance.submit_sed_batch_request() + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_batch_request(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) /suggested-entitlement-description-approvals: post: tags: @@ -83096,6 +96520,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-approval + source: | + [sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval + sed_approval = { + "items" : "016629d1-1d25-463f-97f3-c6686846650" + } # List[SedApproval] | Sed Approval + + try: + # Submit Bulk Approval Request + Result = sed_approval.from_json(sed_approval) + api_response = api_instance.submit_sed_approval(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_approval(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) /suggested-entitlement-description-assignments: post: tags: @@ -83212,6 +96655,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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 + Result = sed_assignment.from_json(sed_assignment) + api_response = api_instance.submit_sed_assignment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_sed_assignment(Result) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) /suggested-entitlement-descriptions: get: tags: @@ -83419,6 +96883,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#list-seds + 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) + 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 + + api_response = api_instance.list_seds() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) patch: tags: - Suggested Entitlement Description @@ -83514,6 +97000,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#patch-sed + source: | + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + [sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request + sed_patch = { + "op" : "replace", + "path" : "status", + "value" : "approved" + } # List[SedPatch] | Sed Patch Request + + try: + # Patch Suggested Entitlement Description + Result = sed_patch.from_json(sed_patch) + api_response = api_instance.patch_sed(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sed(id, Result) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) /discovered-applications: get: operationId: getDiscoveredApplications @@ -83827,6 +97335,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-discovered-applications + 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) + 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 + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + 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 @@ -83890,6 +97417,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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 @@ -83953,6 +97494,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -84122,6 +97676,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) post: security: - userAuth: @@ -84207,6 +97775,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) delete: security: - userAuth: @@ -84296,6 +97901,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) /source-apps/{id}: get: operationId: getSourceApp @@ -84457,6 +98099,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#get-source-app + source: | + 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 + + api_response = api_instance.get_source_app(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->get_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) patch: operationId: patchSourceApp tags: @@ -84695,6 +98353,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#patch-source-app + source: | + 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') + [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch source app by ID + + api_response = api_instance.patch_source_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_source_app(id, x_sail_point_experimental, Result) + print("The response of AppsApi->patch_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) delete: operationId: deleteSourceApp security: @@ -84763,6 +98444,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#delete-source-app + source: | + 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 + + api_response = api_instance.delete_source_app(id, x_sail_point_experimental) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->delete_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) /source-apps/bulk-update: post: operationId: updateSourceAppsInBulk @@ -84870,6 +98567,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#update-source-apps-in-bulk + source: | + x_sail_point_experimental = 'true' # 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 + + api_instance.update_source_apps_in_bulk(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_instance.update_source_apps_in_bulk(x_sail_point_experimental, Result) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) /source-apps/assigned: get: operationId: listAssignedSourceApp @@ -84977,6 +98699,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-assigned-source-app + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) /source-apps: get: operationId: listAvailableSourceApps @@ -85084,6 +98826,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-available-source-apps + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_available_source_apps(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) post: operationId: createSourceApp tags: @@ -85204,6 +98966,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#create-source-app + source: | + x_sail_point_experimental = 'true' # 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 + Result = source_app_create_dto.from_json(source_app_create_dto) + api_response = api_instance.create_source_app(x_sail_point_experimental, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_app(x_sail_point_experimental, Result) + print("The response of AppsApi->create_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) /source-apps/all: get: operationId: listAllSourceApp @@ -85317,6 +99104,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-all-source-app + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_all_source_app(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) /source-apps/{id}/access-profiles: get: operationId: listAccessProfilesForSourceApp @@ -85607,6 +99414,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-access-profiles-for-source-app + source: | + 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 + + api_response = api_instance.list_access_profiles_for_source_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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 @@ -85696,6 +99522,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + 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] | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + pprint(api_response) + 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 @@ -85887,6 +99733,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#patch-user-app + source: | + 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') + [sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | (optional) + + try: + # Patch user app by ID + + api_response = api_instance.patch_user_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_user_app(id, x_sail_point_experimental, Result) + print("The response of AppsApi->patch_user_app:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) /user-apps/{id}/available-accounts: get: operationId: listAvailableAccountsForUserApp @@ -85994,6 +99863,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-available-accounts-for-user-app + source: | + 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 + + api_response = api_instance.list_available_accounts_for_user_app(id, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) /user-apps: get: operationId: listOwnedUserApps @@ -86087,6 +99974,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-owned-user-apps + source: | + x_sail_point_experimental = 'true' # 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 + + api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) /user-apps/all: get: operationId: listAllUserApps @@ -86184,6 +100090,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/apps#list-all-user-apps + source: | + 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 + + api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(api_response) + 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 @@ -86263,6 +100188,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-attribute-key-and-value-to-role + source: | + 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. + + api_response = api_instance.update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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. @@ -86338,6 +100280,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + 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. + + api_instance.delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -86490,6 +100447,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-ids + source: | + 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 + Result = role_metadata_bulk_update_by_id_request.from_json(role_metadata_bulk_update_by_id_request) + api_response = api_instance.update_roles_metadata_by_ids(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_ids(Result) + print("The response of RolesApi->update_roles_metadata_by_ids:\n") + pprint(api_response) + 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 @@ -86642,6 +100622,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-filter + source: | + 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 + Result = role_metadata_bulk_update_by_filter_request.from_json(role_metadata_bulk_update_by_filter_request) + api_response = api_instance.update_roles_metadata_by_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_filter(Result) + print("The response of RolesApi->update_roles_metadata_by_filter:\n") + pprint(api_response) + 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 @@ -86820,6 +100823,44 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-query + source: | + 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 + Result = role_metadata_bulk_update_by_query_request.from_json(role_metadata_bulk_update_by_query_request) + api_response = api_instance.update_roles_metadata_by_query(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_roles_metadata_by_query(Result) + print("The response of RolesApi->update_roles_metadata_by_query:\n") + pprint(api_response) + 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 @@ -86889,6 +100930,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status-by-id + source: | + 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 + + api_response = api_instance.get_bulk_update_status_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_bulk_update_status_by_id(id) + print("The response of RolesApi->get_bulk_update_status_by_id:\n") + pprint(api_response) + 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 @@ -86968,6 +101024,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status + source: | + try: + # Get Bulk-Update Statuses + + api_response = api_instance.get_bulk_update_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_bulk_update_status() + print("The response of RolesApi->get_bulk_update_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) /roles/filter: post: operationId: searchRolesByFilter @@ -87162,6 +101232,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/roles#search-roles-by-filter + source: | + 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 + + api_response = api_instance.search_roles_by_filter() + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, Result) + print("The response of RolesApi->search_roles_by_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) security: - userAuth: - sp:scopes:all @@ -87624,6 +101722,7 @@ components: description: Name of the Object type: string example: aName + nullable: true created: description: Creation date of the Object type: string @@ -87763,6 +101862,7 @@ components: example: true identity: description: The identity this account is correlated to + type: object properties: id: type: string @@ -89524,6 +103624,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: @@ -89836,6 +103937,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: @@ -91944,6 +106046,7 @@ components: example: megapod-useast1 iqServiceVersion: type: string + nullable: true description: The version of the iqService example: iqVersion123 status: @@ -91959,6 +106062,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: @@ -92994,10 +107098,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 +107119,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: diff --git a/static/code-examples/v3/merged_code_examples.yaml b/static/code-examples/v3/merged_code_examples.yaml new file mode 100644 index 000000000..198c4fe79 --- /dev/null +++ b/static/code-examples/v3/merged_code_examples.yaml @@ -0,0 +1,18201 @@ +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#create-access-profile + source: | + $AccessProfile = @" + { + "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 + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-AccessProfile -AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-AccessProfile -AccessProfile $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +- path: /access-profiles + method: GET + xCodeSample: + - 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) + $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) + $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) + + # List Access Profiles + + try { + Get-AccessProfiles + + # Below is a request that includes all optional parameters + # Get-AccessProfiles -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-AccessProfiles" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#delete-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Remove-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#get-access-profile + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-AccessProfile -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#patch-access-profile + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AccessProfile -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AccessProfile -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#delete-access-profiles-in-bulk + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-profiles#get-access-profile-entitlements + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $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 = "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* 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, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-AccessProfileEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#approve-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-AccessRequest -ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#approve-access-request + source: | + 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 + + api_response = api_instance.approve_access_request(approval_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#forward-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#forward-access-request + source: | + 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 + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#get-access-request-approval-summary + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#list-completed-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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 # 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 "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: **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" # 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) + + # Completed Access Request Approvals List + + try { + Get-CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-completed-approvals + source: | + 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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#list-pending-approvals + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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 # 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 "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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $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-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-PendingApprovals + + # Below is a request that includes all optional parameters + # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-pending-approvals + source: | + 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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-request-approvals#reject-access-request + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#reject-access-request + source: | + 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 + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#cancel-access-request + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-AccessRequest -CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-AccessRequest -CancelAccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#create-access-request + source: | + $AccessRequest = @" + { + "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" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-AccessRequest -AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-AccessRequest -AccessRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#get-access-request-config + source: | + + # Get Access Request Configuration + + try { + Get-AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#set-access-request-config + source: | + $AccessRequestConfig = @" + { + "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 + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-AccessRequestConfig -AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-AccessRequestConfig -AccessRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/access-requests#list-access-request-status + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | 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) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | 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 # Boolean | 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 = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | 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"" # 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: **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" # 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, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-activities#get-account-activity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-AccountActivity -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-activities#list-account-activities + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | 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 # 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 = "type eq "Identity Refresh"" # 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: **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" # 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: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-AccountActivities + + # Below is a request that includes all optional parameters + # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-activities#list-account-activities + source: | + 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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 = "-date" # 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: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#create-account + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-Account -AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-Account -AccountAttributesCreate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#list-accounts + 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) + $DetailLevel = "SLIM" # String | 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"" # 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* **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" # 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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-Accounts + + # Below is a request that includes all optional parameters + # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#list-accounts + 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) + 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 + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#delete-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-Account -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#get-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-Account -Id $Id + + # Below is a request that includes all optional parameters + # Get-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#put-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-Account -Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-Account -Id $Id -AccountAttributes $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#update-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Account -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Account -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#update-account + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#disable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#enable-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-Account -Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-Account -Id $Id -AccountToggleRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#get-account-entitlements + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account 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) + + # Account Entitlements + + try { + Get-AccountEntitlements -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#get-account-entitlements + source: | + 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 + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#submit-reload-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-ReloadAccount -Id $Id + + # Below is a request that includes all optional parameters + # Submit-ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/accounts#unlock-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-Account -Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-Account -Id $Id -AccountUnlockRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $Detail = "SLIM" # String | 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")" # 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, 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" # 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, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-discovered-applications + 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) + 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 + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + + # Download CSV Template for Discovery + + try { + Get-ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/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-ManualDiscoverApplicationsCsvTemplate -File $File + + # Below is a request that includes all optional parameters + # Send-ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/auth-users#get-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-AuthUser -Id $Id + + # Below is a request that includes all optional parameters + # Get-AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/auth-users#get-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + api_response = api_instance.get_auth_user(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/auth-users#patch-auth-user + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthUser -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthUser -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/auth-users#patch-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_user(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_user(id, Result) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#create-branding-item + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-BrandingItem -Name $Name -ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#create-branding-item + source: | + 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 + + api_response = api_instance.create_branding_item(name, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#get-branding-list + source: | + + # List of branding items + + try { + Get-BrandingList + + # Below is a request that includes all optional parameters + # Get-BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#get-branding-list + source: | + try: + # List of branding items + + api_response = api_instance.get_branding_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#delete-branding + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-Branding -Name $Name + + # Below is a request that includes all optional parameters + # Remove-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#delete-branding + source: | + 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 + + api_instance.delete_branding(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_branding(name) + except Exception as e: + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#get-branding + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-Branding -Name $Name + + # Below is a request that includes all optional parameters + # Get-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#get-branding + source: | + 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 + + api_response = api_instance.get_branding(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/branding#set-branding-item + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#set-branding-item + source: | + 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 + + api_response = api_instance.set_branding_item(name, name2, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#create-campaign-filter + source: | + $CampaignFilterDetails = @" + { + "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 + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-CampaignFilter -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-CampaignFilter -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#create-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.create_campaign_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_filter(Result) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#list-campaign-filters + 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) + $Start = 0 # Int32 | 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) + $IncludeSystemFilters = $true # Boolean | 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) + + # List Campaign Filters + + try { + Get-CampaignFilters + + # Below is a request that includes all optional parameters + # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#list-campaign-filters + 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) + 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 + + api_response = api_instance.list_campaign_filters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#delete-campaign-filters + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-CampaignFilters -RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-CampaignFilters -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#delete-campaign-filters + source: | + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + + try: + # Deletes Campaign Filters + Result = request_body.from_json(request_body) + api_instance.delete_campaign_filters(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_filters(Result) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-CampaignFilterById -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + 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 + + api_response = api_instance.get_campaign_filter_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaign-filters#update-campaign-filter + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "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 + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#update-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.update_campaign_filter(filter_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign_filter(filter_id, Result) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#complete-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Complete-Campaign -Id $Id -CampaignCompleteOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#complete-campaign + source: | + 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 + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#create-campaign + source: | + $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" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-Campaign -Campaign $Result + + # Below is a request that includes all optional parameters + # New-Campaign -Campaign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign + source: | + 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 + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-active-campaigns + source: | + $Detail = "SLIM" # String | 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 # 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 "Manager Campaign"" # 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* **status**: *eq, in* (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, created** (optional) + + # List Campaigns + + try { + Get-ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#create-campaign-template + source: | + $CampaignTemplate = @" + { + "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" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-CampaignTemplate -CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-CampaignTemplate -CampaignTemplate $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign-template + source: | + 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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-templates + 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 = "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, created, modified** (optional) + $Filters = "name eq "manager template"" # 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, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-CampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#patch-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#set-campaign-template-schedule + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | 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" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-CampaignTemplateSchedule -Id $Id + + # Below is a request that includes all optional parameters + # Set-CampaignTemplateSchedule -Id $Id -Schedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#delete-campaigns + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-Campaigns -CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-Campaigns -CampaignsDeleteRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaigns + source: | + campaigns_delete_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = campaigns_delete_request.from_json(campaigns_delete_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Get-Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign + source: | + 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 + + api_response = api_instance.get_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#update-campaign + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Campaign -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Campaign -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-CampaignReports -Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports-config + source: | + + # Get Campaign Reports Configuration + + try { + Get-CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#set-campaign-reports-config + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-CampaignReportsConfig -CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-CampaignReportsConfig -CampaignReportsConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#move + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move- -Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move- -Id $Id -AdminReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-Campaign -Id $Id + + # Below is a request that includes all optional parameters + # Start-Campaign -Id $Id -ActivateCampaignOptions $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign-remediation-scan + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-CampaignRemediationScan -Id $Id + + # Below is a request that includes all optional parameters + # Start-CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-campaign-report + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-CampaignReport -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-report + source: | + 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 + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#start-generate-campaign-template + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-GenerateCampaignTemplate -Id $Id + + # Below is a request that includes all optional parameters + # Start-GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $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 "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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + 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 + + api_response = api_instance.get_identity_access_summaries(id, type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.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: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + 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 + + api_response = api_instance.get_identity_decision_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification 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) + $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, in* **completed**: *eq, ne* **name**: *eq, 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) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + 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 + + api_response = api_instance.get_identity_summaries(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + 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 + + api_response = api_instance.get_identity_summary(id, identity_summary_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-certification-task + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-CertificationTask -Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-certification-task + source: | + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + api_response = api_instance.get_certification_task(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-IdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + api_response = api_instance.get_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-identity-certification-item-permissions + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # 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: **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 # 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) + + # Permissions for Entitlement Certification Item + + try { + Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification-item-permissions + source: | + 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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#get-pending-certification-tasks + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *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 = "type eq "ADMIN_REASSIGN"" # 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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-pending-certification-tasks + source: | + 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 + + api_response = api_instance.get_pending_certification_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#list-certification-reviewers + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification 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) + $Filters = "name eq "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, sw* **email**: *eq, 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, email** (optional) + + # List of Reviewers for certification + + try { + Get-CertificationReviewers -Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#list-identity-access-review-items + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification 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) + $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, 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" # 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | 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) + $AccessProfiles = "accessProfile1" # String | 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" # String | 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) + + # List of Access Review Items + + try { + Get-IdentityAccessReviewItems -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-access-review-items + source: | + 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 + + api_response = api_instance.list_identity_access_review_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#list-identity-certifications + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *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 = "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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # 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, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-certifications + source: | + 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 + + api_response = api_instance.list_identity_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#make-identity-decision + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-IdentityDecision -Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-IdentityDecision -Id $Id -ReviewDecision $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#make-identity-decision + source: | + 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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + try: + # Decide on a Certification Item + Result = review_decision.from_json(review_decision) + api_response = api_instance.make_identity_decision(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.make_identity_decision(id, Result) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#reassign-identity-certifications + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#reassign-identity-certifications + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.reassign_identity_certifications(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reassign_identity_certifications(id, Result) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#sign-off-identity-certification + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-SignOffIdentityCertification -Id $Id + + # Below is a request that includes all optional parameters + # Invoke-SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#sign-off-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + api_response = api_instance.sign_off_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certifications#submit-reassign-certs-async + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mapping + source: | + 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 + Result = object_mapping_request.from_json(object_mapping_request) + api_response = api_instance.create_object_mapping(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mapping(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#get-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-ObjectMappings -SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-object-mappings + source: | + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + api_response = api_instance.get_object_mappings(source_org) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "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" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mappings + source: | + 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 + Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + api_response = api_instance.create_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#create-uploaded-configuration + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-UploadedConfiguration -Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-uploaded-configuration + source: | + 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 + + api_response = api_instance.create_uploaded_configuration(data, name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#list-uploaded-configurations + source: | + $Filters = "status eq "COMPLETE"" # 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: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#list-uploaded-configurations + source: | + 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 + + api_response = api_instance.list_uploaded_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#delete-object-mapping + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-object-mapping + source: | + 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 + + api_instance.delete_object_mapping(source_org, object_mapping_id) + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#delete-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-uploaded-configuration + source: | + 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 + + api_instance.delete_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_uploaded_configuration(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#get-uploaded-configuration + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-UploadedConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-uploaded-configuration + source: | + 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 + + api_response = api_instance.get_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/configuration-hub#update-object-mappings + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "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" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#update-object-mappings + source: | + 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 + Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + api_response = api_instance.update_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) +- path: /connectors + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#create-custom-connector + source: | + v3_create_connector_dto = { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } # V3CreateConnectorDto | + try: + # Create Custom Connector + Result = v3_create_connector_dto.from_json(v3_create_connector_dto) + api_response = api_instance.create_custom_connector(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_connector(Result) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) +- path: /connectors + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-list + source: | + 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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#delete-custom-connector + source: | + 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 + + api_instance.delete_custom_connector(script_name) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector + source: | + 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 + + api_response = api_instance.get_connector(script_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#update-connector + source: | + 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. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + try: + # Update Connector by Script Name + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_connector(script_name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector(script_name, Result) + print("The response of ConnectorsApi->update_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-config + source: | + 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 + + api_response = api_instance.get_connector_source_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-config + source: | + 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 + + api_response = api_instance.put_connector_source_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-template + source: | + 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 + + api_response = api_instance.get_connector_source_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-template + source: | + 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 + + api_response = api_instance.put_connector_source_template(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-translations + source: | + 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 + + api_response = api_instance.get_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-translations + source: | + 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 + + api_response = api_instance.put_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-AuthOrgNetworkConfig -NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-AuthOrgNetworkConfig -NetworkConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + 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. + Result = network_configuration.from_json(network_configuration) + api_response = api_instance.create_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + + # Get security network configuration. + + try { + Get-AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + try: + # Get security network configuration. + + api_response = api_instance.get_auth_org_network_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgNetworkConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgNetworkConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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. + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + try: + # Get Auth Org Lockout Configuration. + + api_response = api_instance.get_auth_org_lockout_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + [{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` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_lockout_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_lockout_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + try: + # Get Service Provider Configuration. + + api_response = api_instance.get_auth_org_service_provider_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_service_provider_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_service_provider_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + try: + # Get Auth Org Session Configuration. + + api_response = api_instance.get_auth_org_session_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + [{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.` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_session_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_session_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +- path: /identity-profiles + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#create-identity-profile + source: | + 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 + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +- path: /identity-profiles + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#list-identity-profiles + 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) + 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +- path: /identity-profiles/export + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#export-identity-profiles + 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) + 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +- path: /identity-profiles/import + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.v3.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#show-identity-preview + source: | + 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.show_identity_preview(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_identity_preview(Result) + print("The response of IdentityProfilesApi->show_identity_preview:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#create-lifecycle-state + source: | + 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 + Result = lifecycle_state.from_json(lifecycle_state) + api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#delete-lifecycle-state + source: | + 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 + + api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-state + source: | + 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 + + api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#set-lifecycle-state + source: | + 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 + Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request) + api_response = api_instance.set_lifecycle_state(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_lifecycle_state(identity_id, Result) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#delete-mfa-config + source: | + 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 + + api_response = api_instance.delete_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +- path: /mfa/token/send + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#create-send-token + source: | + send_token_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } # SendTokenRequest | + try: + # Create and send user token + Result = send_token_request.from_json(send_token_request) + api_response = api_instance.create_send_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_send_token(Result) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#ping-verification-status + source: | + 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 + Result = verification_poll_request.from_json(verification_poll_request) + api_response = api_instance.ping_verification_status(method, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_verification_status(method, Result) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-duo-verify-request + source: | + duo_verification_request = { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + Result = duo_verification_request.from_json(duo_verification_request) + api_response = api_instance.send_duo_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_duo_verify_request(Result) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-kba-answers + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Authenticate KBA provided MFA method + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.send_kba_answers(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_kba_answers(Result) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-okta-verify-request + source: | + okta_verification_request = { + "userId" : "example@mail.com" + } # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + Result = okta_verification_request.from_json(okta_verification_request) + api_response = api_instance.send_okta_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_okta_verify_request(Result) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-token-auth-request + source: | + token_auth_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + Result = token_auth_request.from_json(token_auth_request) + api_response = api_instance.send_token_auth_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_token_auth_request(Result) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + managed_client_request = { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } # ManagedClientRequest | + try: + # Create Managed Client + Result = managed_client_request.from_json(managed_client_request) + api_response = api_instance.create_managed_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_client(Result) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + 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 + + api_response = api_instance.get_managed_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + api_instance.delete_managed_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + api_response = api_instance.get_managed_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Client + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client(id, Result) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + 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 + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + 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 + Result = managed_cluster_request.from_json(managed_cluster_request) + api_response = api_instance.create_managed_cluster(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_cluster(Result) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + 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 + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + 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 + + api_instance.delete_managed_cluster(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Cluster + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_cluster(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_cluster(id, Result) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + 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 + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + 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 + Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request) + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + 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 + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +- path: /non-employee-records + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +- path: /non-employee-records + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +- path: /non-employee-requests + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +- path: /non-employee-requests + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +- path: /non-employee-sources + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +- path: /non-employee-sources + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + 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 + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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/{sourceId}/schema-attributes + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.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/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + delete_non_employee_records_in_bulk_request = sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + api_instance.delete_non_employee_records_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_records_in_bulk(Result) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + 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 + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + 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 + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + 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 + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + 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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + 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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + 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 + + api_response = api_instance.list_non_employee_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + 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 + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) +- path: /oauth-clients + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#create-oauth-client + source: | + 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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) +- path: /oauth-clients + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-configuration#create-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-configuration#get-password-org-config + source: | + + # Get Password Org Config + + try { + Get-PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-configuration#put-password-org-config + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-PasswordOrgConfig -PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-PasswordOrgConfig -PasswordOrgConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#get-password-dictionary + source: | + + # Get Password Dictionary + + try { + Get-PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#put-password-dictionary + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-management#get-password-change-status + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-PasswordChangeStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#get-password-change-status + source: | + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + api_response = api_instance.get_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-management#query-password-info + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-PasswordInfo -PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-PasswordInfo -PasswordInfoQueryDTO $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/password-management#set-password + source: | + $PasswordChangeRequest = @" + { + "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==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-Password -PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-Password -PasswordChangeRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#set-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password(Result) + print("The response of PasswordManagementApi->set_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) +- path: /password-policies + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) +- path: /password-policies + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) +- path: /password-policies/{id} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) +- path: /password-sync-groups + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) +- path: /password-sync-groups + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) +- path: /personal-access-tokens + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) +- path: /personal-access-tokens + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.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/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +- path: /public-identities + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities#get-public-identities + 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) + 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 + + api_response = api_instance.get_public_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) +- path: /public-identities-config + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get the Public Identities Configuration + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +- path: /public-identities-config + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities-config#update-public-identity-config + source: | + 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 + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#cancel-report + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-Report -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#cancel-report + source: | + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + api_instance.cancel_report(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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 + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | 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) + + # Get Report File + + try { + Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report + source: | + 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 + + api_response = api_instance.get_report(task_result_id, file_format, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#get-report-result + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-ReportResult -TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report-result + source: | + 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 + + api_response = api_instance.get_report_result(task_result_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/reports-data-extraction#start-report + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-Report -ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-Report -ReportDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#start-report + source: | + report_details = { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } # ReportDetails | + try: + # Run Report + Result = report_details.from_json(report_details) + api_response = api_instance.start_report(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_report(Result) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) +- path: /requestable-objects + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/requestable-objects#list-requestable-objects + source: | + 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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +- path: /roles + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) +- path: /roles + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) +- path: /roles/bulk-delete + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +- path: /roles/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +- path: /roles/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +- path: /roles/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#get-role-assigned-identities + source: | + 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 + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "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" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (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, description** (optional) + + # List SOD policies + + try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy + source: | + 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 + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + 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 + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "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" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + 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 + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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 = @" + { + "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 + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + 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 + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Download custom violation report + + try { + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + 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 + + api_response = api_instance.start_evaluate_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + 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 + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + 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 + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "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" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + 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 + Result = identity_with_new_access1.from_json(identity_with_new_access1) + api_response = api_instance.start_violation_check(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_violation_check(Result) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /saved-searches + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#create-saved-search + source: | + create_saved_search_request = sailpoint.v3.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + Result = create_saved_search_request.from_json(create_saved_search_request) + api_response = api_instance.create_saved_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_saved_search(Result) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) +- path: /saved-searches + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#list-saved-searches + source: | + 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 + + api_response = api_instance.list_saved_searches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#delete-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + api_instance.delete_saved_search(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) +- path: /saved-searches/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#get-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + api_response = api_instance.get_saved_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#put-saved-search + source: | + 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 + Result = saved_search.from_json(saved_search) + api_response = api_instance.put_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_saved_search(id, Result) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#execute-saved-search + source: | + 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 + Result = search_arguments.from_json(search_arguments) + api_instance.execute_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.execute_saved_search(id, Result) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) +- path: /scheduled-searches + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#create-scheduled-search + source: | + 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 + Result = create_scheduled_search_request.from_json(create_scheduled_search_request) + api_response = api_instance.create_scheduled_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_scheduled_search(Result) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) +- path: /scheduled-searches + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#list-scheduled-search + source: | + 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 + + api_response = api_instance.list_scheduled_search() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#delete-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + api_instance.delete_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_instance.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: 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#get-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + api_response = api_instance.get_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#update-scheduled-search + source: | + 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 + Result = scheduled_search.from_json(scheduled_search) + api_response = api_instance.update_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_scheduled_search(id, Result) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#unsubscribe-scheduled-search + source: | + 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 + Result = typed_reference.from_json(typed_reference) + api_instance.unsubscribe_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.unsubscribe_scheduled_search(id, Result) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) +- path: /search/aggregate + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_aggregate(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_aggregate(Result, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) +- path: /search/count + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/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" + } + } + } # Search | + try: + # Count Documents Satisfying a Query + Result = search.from_json(search) + api_instance.search_count(Result) + + # Below is a request that includes all optional parameters + # api_instance.search_count(Result) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) +- path: /search/{index}/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search#search-get + source: | + 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 + + api_response = api_instance.search_get(index, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) +- path: /search + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_post(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_post(Result, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-SearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-SearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#create-search-attribute-config + source: | + search_attribute_config = { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } # SearchAttributeConfig | + try: + # Create Extended Search Attributes + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + + # List Extended Search Attributes + + try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + try: + # List Extended Search Attributes + + api_response = api_instance.get_search_attribute_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-SearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-SearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_instance.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/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-SingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-SingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + 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 + + api_response = api_instance.get_single_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + 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: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#create-service-desk-integration + source: | + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - 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 + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integrations + source: | + 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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v3.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 = "-date" # 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: **date** (optional) + + # Returns source usage insights + + try { + Get-UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#create-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "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" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#list-provisioning-policies + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-ProvisioningPolicies -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#create-source + source: | + $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" + } + "@ + $ProvisionAsCsv = $false # Boolean | 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) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-Source -Source $Result + + # Below is a request that includes all optional parameters + # New-Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 "Employees"" # 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, 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" # 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: **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) + $ForSubadmin = "name" # String | 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) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-Sources + + # Below is a request that includes all optional parameters + # Get-Sources -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-Sources" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#list-sources + 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) + 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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#create-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-SourceSchema -SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-SourceSchema -SourceId $SourceId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.v3.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-SourceSchemas -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Delete Provisioning Policy by UsageType + + try { + Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Get Provisioning Policy by UsageType + + try { + Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + $ProvisioningPolicyDto = @" + { + "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" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v3.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#delete-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Source -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-Source -Id $Id + + # Below is a request that includes all optional parameters + # Get-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#put-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | 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" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-Source -Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-Source -Id $Id -Source $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Source -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Source -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#delete-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#put-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + + # Below is a request that includes all optional parameters + # Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-source-schema + source: | + 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.v3.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_accounts_schema(id) + + # Below is a request that includes all optional parameters + # api_instance.get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#import-accounts-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-AccountsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_accounts_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-entitlements-schema + source: | + 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 + + api_instance.get_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#import-entitlements-schema + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-EntitlementsSchema -Id $Id + + # Below is a request that includes all optional parameters + # Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-entitlements-schema + source: | + 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 + + api_response = api_instance.import_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-connections + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-SourceConnections -Id $Id + + # Below is a request that includes all optional parameters + # Get-SourceConnections -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-connections + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source Connections by ID + + api_response = api_instance.get_source_connections(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_connections(id) + print("The response of SourcesApi->get_source_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-health + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-SourceHealth -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-health + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + api_response = api_instance.get_source_health(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#import-connector-file + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-ConnectorFile -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-connector-file + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sources#update-provisioning-policies-in-bulk + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "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" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Delete Object Tags + + try { + Remove-TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Get Tagged Object + + try { + Get-TaggedObject -Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#delete-tags-to-many-object + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-TagsToManyObject -BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-TagsToManyObject -BulkRemoveTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tags-to-many-object + source: | + 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 + Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 = "tagName eq "BU_FINANCE"" # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-TaggedObjects + + # Below is a request that includes all optional parameters + # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#set-tag-to-object + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-TagToObject -TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagToObject -TaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 = "objectRef.id 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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-TaggedObjectsByType -Type $Type + + # Below is a request that includes all optional parameters + # Get-TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/tagged-objects#set-tags-to-many-objects + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-TagsToManyObjects -BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagsToManyObjects -BulkAddTaggedObject $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tags-to-many-objects + source: | + 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 + Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#create-transform + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-Transform -Transform $Result + + # Below is a request that includes all optional parameters + # New-Transform -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # 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: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-Transforms + + # Below is a request that includes all optional parameters + # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#delete-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-Transform -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#get-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-Transform -Id $Id + + # Below is a request that includes all optional parameters + # Get-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/transforms#update-transform + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-Transform -Id $Id + + # Below is a request that includes all optional parameters + # Update-Transform -Id $Id -Transform $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "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" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + $VendorConnectorMapping = @" + { + "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" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-VendorConnectorMapping -VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-VendorConnectorMapping -VendorConnectorMapping $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + + # List Vendor Connector Mappings + + try { + Get-VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Approve an Approval Item + + try { + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + api_response = api_instance.get_count_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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. + + # Reject an Approval Item + + try { + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk -Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + try: + # Forward a Work Item + Result = work_item_forward.from_json(work_item_forward) + api_instance.send_work_item_forward(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_work_item_forward(id, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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 + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = sailpoint.v3.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.create_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-Workflows + + # Below is a request that includes all optional parameters + # Get-Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.create_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow + source: | + 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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.put_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_workflow(id, Result) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $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 = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-executions + source: | + 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 + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + + # List Complete Workflow Library + + try { + Get-CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $Filters = "id eq "sp:create-campaign"" # 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* (optional) + + # List Workflow Library Actions + + try { + Get-WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) + $Filters = "id eq "idn:identity-attributes-changed"" # 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* (optional) + + # List Workflow Library Triggers + + try { + Get-WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.v3.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {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}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) 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..de7fb606c --- /dev/null +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -0,0 +1,9203 @@ +- path: /access-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + 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: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + 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: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + 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: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + 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: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.approve_access_request(approval_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + 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: | + 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 + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + 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: | + 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 + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + 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: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + 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: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + 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: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + 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: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + 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: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %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: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-discovered-applications + 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) + 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 + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + 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: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + api_response = api_instance.get_auth_user(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_user(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_user(id, Result) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.create_branding_item(name, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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: | + 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 + + api_instance.delete_branding(name) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_branding(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(api_response) + 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: | + try: + # List of branding items + + api_response = api_instance.get_branding_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.set_branding_item(name, name2, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.create_campaign_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_filter(Result) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(api_response) + 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: | + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + + try: + # Deletes Campaign Filters + Result = request_body.from_json(request_body) + api_instance.delete_campaign_filters(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_filters(Result) + 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: | + 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 + + api_response = api_instance.get_campaign_filter_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_campaign_filters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(api_response) + 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: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.update_campaign_filter(filter_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign_filter(filter_id, Result) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + 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: | + 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 + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + 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: | + 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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + 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: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + campaigns_delete_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = campaigns_delete_request.from_json(campaigns_delete_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + 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: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + 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: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + 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: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + 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: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + 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: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + 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: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + 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: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + 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: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-certification-task + source: | + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + api_response = api_instance.get_certification_task(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + api_response = api_instance.get_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_pending_certification_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_identity_access_review_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_identity_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(api_response) + 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: | + 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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + try: + # Decide on a Certification Item + Result = review_decision.from_json(review_decision) + api_response = api_instance.make_identity_decision(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.make_identity_decision(id, Result) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(api_response) + 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: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.reassign_identity_certifications(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reassign_identity_certifications(id, Result) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + api_response = api_instance.sign_off_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(api_response) + 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: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %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: | + 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 + + api_response = api_instance.get_identity_access_summaries(id, type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_identity_decision_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_identity_summaries(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_identity_summary(id, identity_summary_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %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: | + 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 + Result = object_mapping_request.from_json(object_mapping_request) + api_response = api_instance.create_object_mapping(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mapping(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(api_response) + 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: | + 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 + Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + api_response = api_instance.create_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.create_uploaded_configuration(data, name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(api_response) + 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: | + 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 + + api_instance.delete_object_mapping(source_org, object_mapping_id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_instance.delete_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + api_response = api_instance.get_object_mappings(source_org) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_uploaded_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(api_response) + 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: | + 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 + Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + api_response = api_instance.update_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + pprint(api_response) + 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: | + v3_create_connector_dto = { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } # V3CreateConnectorDto | + try: + # Create Custom Connector + Result = v3_create_connector_dto.from_json(v3_create_connector_dto) + api_response = api_instance.create_custom_connector(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_connector(Result) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(api_response) + 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: | + 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 + + api_instance.delete_custom_connector(script_name) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_connector(script_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_connector_source_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_connector_source_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.put_connector_source_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.put_connector_source_template(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.put_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(api_response) + 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: | + 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. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + try: + # Update Connector by Script Name + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_connector(script_name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector(script_name, Result) + print("The response of ConnectorsApi->update_connector:\n") + pprint(api_response) + 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: | + 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. + Result = network_configuration.from_json(network_configuration) + api_response = api_instance.create_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(api_response) + 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: | + try: + # Get Auth Org Lockout Configuration. + + api_response = api_instance.get_auth_org_lockout_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + pprint(api_response) + 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: | + try: + # Get security network configuration. + + api_response = api_instance.get_auth_org_network_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(api_response) + 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: | + try: + # Get Service Provider Configuration. + + api_response = api_instance.get_auth_org_service_provider_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + pprint(api_response) + 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: | + try: + # Get Auth Org Session Configuration. + + api_response = api_instance.get_auth_org_session_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + pprint(api_response) + 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: | + [{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` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_lockout_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_lockout_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + pprint(api_response) + 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: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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. + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + pprint(api_response) + 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: | + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_service_provider_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_service_provider_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + pprint(api_response) + 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: | + [{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.` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_session_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_session_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + pprint(api_response) + 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: | + 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 + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + 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: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + 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: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + 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: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + 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: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + 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: | + [sailpoint.v3.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + 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: | + 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.show_identity_preview(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_identity_preview(Result) + print("The response of IdentityProfilesApi->show_identity_preview:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + 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: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + 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: | + 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 + Result = lifecycle_state.from_json(lifecycle_state) + api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + 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: | + 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 + Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request) + api_response = api_instance.set_lifecycle_state(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_lifecycle_state(identity_id, Result) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(api_response) + 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: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + managed_client_request = { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } # ManagedClientRequest | + try: + # Create Managed Client + Result = managed_client_request.from_json(managed_client_request) + api_response = api_instance.create_managed_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_client(Result) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(api_response) + 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: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + api_instance.delete_managed_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + api_response = api_instance.get_managed_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_managed_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(api_response) + 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: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Client + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client(id, Result) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(api_response) + 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: | + 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 + Result = managed_cluster_request.from_json(managed_cluster_request) + api_response = api_instance.create_managed_cluster(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_cluster(Result) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(api_response) + 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: | + 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 + + api_instance.delete_managed_cluster(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + 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: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + 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: | + 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 + Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request) + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + 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: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Cluster + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_cluster(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_cluster(id, Result) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %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: | + 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 + + api_response = api_instance.delete_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(api_response) + 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: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + 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: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + 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: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + 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: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + 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: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + 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: | + send_token_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } # SendTokenRequest | + try: + # Create and send user token + Result = send_token_request.from_json(send_token_request) + api_response = api_instance.create_send_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_send_token(Result) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(api_response) + 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: | + 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 + Result = verification_poll_request.from_json(verification_poll_request) + api_response = api_instance.ping_verification_status(method, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_verification_status(method, Result) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(api_response) + 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: | + duo_verification_request = { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + Result = duo_verification_request.from_json(duo_verification_request) + api_response = api_instance.send_duo_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_duo_verify_request(Result) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(api_response) + 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: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Authenticate KBA provided MFA method + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.send_kba_answers(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_kba_answers(Result) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(api_response) + 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: | + okta_verification_request = { + "userId" : "example@mail.com" + } # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + Result = okta_verification_request.from_json(okta_verification_request) + api_response = api_instance.send_okta_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_okta_verify_request(Result) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(api_response) + 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: | + token_auth_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + Result = token_auth_request.from_json(token_auth_request) + api_response = api_instance.send_token_auth_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_token_auth_request(Result) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %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: | + 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 + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + 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: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + 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: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + 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: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + 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: | + 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 + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + delete_non_employee_records_in_bulk_request = sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + api_instance.delete_non_employee_records_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_records_in_bulk(Result) + 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: | + 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 + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + 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: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + 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: | + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + 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: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + 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: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + 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: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_non_employee_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + 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: | + 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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + 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: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + 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: | + 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 + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + 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: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + 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: | + 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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + 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: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + 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: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + 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: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + 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: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + 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: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + api_response = api_instance.get_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(api_response) + 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: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + 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: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password(Result) + print("The response of PasswordManagementApi->set_password:\n") + pprint(api_response) + 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: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + 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: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + 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: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + 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: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + 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: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + 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: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + 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: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_public_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + pprint(api_response) + 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: | + try: + # Get the Public Identities Configuration + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + 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: | + 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 + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + 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: | + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + api_instance.cancel_report(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_report(task_result_id, file_format, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_report_result(task_result_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(api_response) + 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: | + report_details = { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } # ReportDetails | + try: + # Run Report + Result = report_details.from_json(report_details) + api_response = api_instance.start_report(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_report(Result) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(api_response) + 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: | + 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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + 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: | + 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 + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + 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: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + 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: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + 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: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /saved-searches + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#create-saved-search + source: | + create_saved_search_request = sailpoint.v3.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + Result = create_saved_search_request.from_json(create_saved_search_request) + api_response = api_instance.create_saved_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_saved_search(Result) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(api_response) + 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: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + api_instance.delete_saved_search(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + Result = search_arguments.from_json(search_arguments) + api_instance.execute_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.execute_saved_search(id, Result) + 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: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + api_response = api_instance.get_saved_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_saved_searches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(api_response) + 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: | + 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 + Result = saved_search.from_json(saved_search) + api_response = api_instance.put_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_saved_search(id, Result) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(api_response) + 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: | + 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 + Result = create_scheduled_search_request.from_json(create_scheduled_search_request) + api_response = api_instance.create_scheduled_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_scheduled_search(Result) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(api_response) + 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: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + api_instance.delete_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + api_response = api_instance.get_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_scheduled_search() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(api_response) + 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: | + 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 + Result = typed_reference.from_json(typed_reference) + api_instance.unsubscribe_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.unsubscribe_scheduled_search(id, Result) + 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: | + 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 + Result = scheduled_search.from_json(scheduled_search) + api_response = api_instance.update_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_scheduled_search(id, Result) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(api_response) + 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: | + 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 + Result = search.from_json(search) + api_response = api_instance.search_aggregate(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_aggregate(Result, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(api_response) + 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: | + 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 + Result = search.from_json(search) + api_instance.search_count(Result) + + # Below is a request that includes all optional parameters + # api_instance.search_count(Result) + 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: | + 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 + + api_response = api_instance.search_get(index, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(api_response) + 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: | + 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 + Result = search.from_json(search) + api_response = api_instance.search_post(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_post(Result, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(api_response) + 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: | + search_attribute_config = { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } # SearchAttributeConfig | + try: + # Create Extended Search Attributes + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + 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: | + 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 + + api_instance.delete_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_instance.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: | + try: + # List Extended Search Attributes + + api_response = api_instance.get_search_attribute_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_single_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + 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: | + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + 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: | + 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 + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + 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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + 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: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + 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: | + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integrations + source: | + 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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v3.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + 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: | + 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 + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + 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: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + 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: | + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + 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: | + 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 + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + 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: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.start_evaluate_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + 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: | + 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 + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + 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: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + 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: | + 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 + Result = identity_with_new_access1.from_json(identity_with_new_access1) + api_response = api_instance.start_violation_check(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_violation_check(Result) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) +- path: /sources + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.v3.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_accounts_schema(id) + + # Below is a request that includes all optional parameters + # api_instance.get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-entitlements-schema + source: | + 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 + + api_instance.get_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-connections + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source Connections by ID + + api_response = api_instance.get_source_connections(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_connections(id) + print("The response of SourcesApi->get_source_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-health + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + api_response = api_instance.get_source_health(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_accounts_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-connector-file + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-entitlements-schema + source: | + 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 + + api_response = api_instance.import_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) +- path: /sources + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#list-sources + 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) + 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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-source-schema + source: | + 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.v3.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v3.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tags-to-many-object + source: | + 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 + Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) +- path: /tagged-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) +- path: /tagged-objects + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tags-to-many-objects + source: | + 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 + Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) +- path: /transforms + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) +- path: /transforms + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = sailpoint.v3.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.create_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) +- path: /workflows + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.create_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-executions + source: | + 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 + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) +- path: /workflow-library + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) +- path: /workflows + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow + source: | + 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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.put_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_workflow(id, Result) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.v3.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) +- path: /work-items/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + api_response = api_instance.get_count_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) +- path: /work-items/count + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) +- path: /work-items/summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) +- path: /work-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + try: + # Forward a Work Item + Result = work_item_forward.from_json(work_item_forward) + api_instance.send_work_item_forward(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_work_item_forward(id, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) diff --git a/static/code-examples/v3/v3.yaml b/static/code-examples/v3/v3.yaml index 0de087319..049329062 100644 --- a/static/code-examples/v3/v3.yaml +++ b/static/code-examples/v3/v3.yaml @@ -1449,6 +1449,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#list-access-profiles + source: | + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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) # str | 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 # 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 = '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* Composite operators supported: *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* Composite operators supported: *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 | 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) # str | 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) + 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 + + api_response = api_instance.list_access_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) post: operationId: createAccessProfile tags: @@ -1603,6 +1625,105 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#create-access-profile + source: | + 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 + Result = access_profile.from_json(access_profile) + api_response = api_instance.create_access_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_profile(Result) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) /access-profiles/{id}: get: operationId: getAccessProfile @@ -1670,6 +1791,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile + source: | + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + api_response = api_instance.get_access_profile(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) patch: operationId: patchAccessProfile tags: @@ -1876,6 +2012,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#patch-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Access Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_access_profile(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_access_profile(id, Result) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) delete: operationId: deleteAccessProfile tags: @@ -1992,6 +2150,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profile + source: | + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + api_instance.delete_access_profile(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) /access-profiles/bulk-delete: post: operationId: deleteAccessProfilesInBulk @@ -2149,6 +2320,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profiles-in-bulk + source: | + access_profile_bulk_delete_request = { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request) + api_response = api_instance.delete_access_profiles_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_access_profiles_in_bulk(Result) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) /access-profiles/{id}/entitlements: get: operationId: getAccessProfileEntitlements @@ -2450,6 +2639,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile-entitlements + source: | + 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 + + api_response = api_instance.get_access_profile_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) /access-requests: post: operationId: createAccessRequest @@ -2572,7 +2781,8 @@ paths: description: The id of the access item requested. example: 779c6fd7171540bba1184e5946112c28 attributesHash: - type: string + type: integer + format: int32 description: a hash representation of the access requested, useful for longer term tracking client side. example: -1928438224 accessRequestIds: @@ -2692,6 +2902,74 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#create-access-request + source: | + 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 + Result = access_request.from_json(access_request) + api_response = api_instance.create_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_access_request(Result) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) /access-requests/cancel: post: operationId: cancelAccessRequest @@ -2790,6 +3068,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#cancel-access-request + source: | + cancel_access_request = { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } # CancelAccessRequest | + try: + # Cancel Access Request + Result = cancel_access_request.from_json(cancel_access_request) + api_response = api_instance.cancel_access_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.cancel_access_request(Result) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) /access-request-config: get: operationId: getAccessRequestConfig @@ -2919,6 +3215,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#get-access-request-config + source: | + try: + # Get Access Request Configuration + + api_response = api_instance.get_access_request_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) put: operationId: setAccessRequestConfig security: @@ -3005,6 +3315,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#set-access-request-config + source: | + 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 + Result = access_request_config.from_json(access_request_config) + api_response = api_instance.set_access_request_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_access_request_config(Result) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) /access-request-status: get: operationId: listAccessRequestStatus @@ -3682,6 +4032,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#list-access-request-status + source: | + 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 + + api_response = api_instance.list_access_request_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) /access-request-approvals/pending: get: operationId: listPendingApprovals @@ -3928,6 +4302,15 @@ paths: sodViolationContext: $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0' x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.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 '400': $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 @@ -3965,6 +4348,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-pending-approvals + source: | + 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 + + api_response = api_instance.list_pending_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) /access-request-approvals/completed: get: operationId: listCompletedApprovals @@ -4222,6 +4625,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-completed-approvals + source: | + 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 + + api_response = api_instance.list_completed_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) /access-request-approvals/{approvalId}/approve: post: operationId: approveAccessRequest @@ -4331,6 +4754,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#approve-access-request + source: | + 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 + + api_response = api_instance.approve_access_request(approval_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) /access-request-approvals/{approvalId}/reject: post: operationId: rejectAccessRequest @@ -4406,6 +4853,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#reject-access-request + source: | + 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 + Result = comment_dto.from_json(comment_dto) + api_response = api_instance.reject_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) /access-request-approvals/{approvalId}/forward: post: operationId: forwardAccessRequest @@ -4491,6 +4962,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#forward-access-request + source: | + 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 + Result = forward_approval_dto.from_json(forward_approval_dto) + api_response = api_instance.forward_access_request(approval_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.forward_access_request(approval_id, Result) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) /access-request-approvals/approval-summary: get: operationId: getAccessRequestApprovalSummary @@ -4582,6 +5072,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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 + + api_response = api_instance.get_access_request_approval_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) /accounts: get: operationId: listAccounts @@ -4888,6 +5394,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#list-accounts + 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) + 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 + + api_response = api_instance.list_accounts() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) post: operationId: createAccount tags: @@ -4999,6 +5525,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#create-account + source: | + account_attributes_create = { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } # AccountAttributesCreate | + try: + # Create Account + Result = account_attributes_create.from_json(account_attributes_create) + api_response = api_instance.create_account(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_account(Result) + print("The response of AccountsApi->create_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) /accounts/{id}: get: operationId: getAccount @@ -5066,6 +5616,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#get-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + api_response = api_instance.get_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) patch: operationId: updateAccount tags: @@ -5179,6 +5744,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#update-account + source: | + 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. + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.update_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_account(id, Result) + print("The response of AccountsApi->update_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) put: operationId: putAccount tags: @@ -5280,6 +5863,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#put-account + source: | + 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 + Result = account_attributes.from_json(account_attributes) + api_response = api_instance.put_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_account(id, Result) + print("The response of AccountsApi->put_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) delete: operationId: deleteAccount tags: @@ -5349,6 +5956,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#delete-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + api_response = api_instance.delete_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) /accounts/{id}/entitlements: get: operationId: getAccountEntitlements @@ -5427,6 +6049,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#get-account-entitlements + source: | + 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 + + api_response = api_instance.get_account_entitlements(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) /accounts/{id}/reload: post: operationId: submitReloadAccount @@ -5494,6 +6134,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#submit-reload-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + api_response = api_instance.submit_reload_account(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) /accounts/{id}/enable: post: operationId: enableAccount @@ -5584,6 +6239,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#enable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Enable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.enable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.enable_account(id, Result) + print("The response of AccountsApi->enable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) /accounts/{id}/disable: post: operationId: disableAccount @@ -5665,6 +6339,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#disable-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } # AccountToggleRequest | + try: + # Disable Account + Result = account_toggle_request.from_json(account_toggle_request) + api_response = api_instance.disable_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.disable_account(id, Result) + print("The response of AccountsApi->disable_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) /accounts/{id}/unlock: post: operationId: unlockAccount @@ -5763,6 +6456,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#unlock-account + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } # AccountUnlockRequest | + try: + # Unlock Account + Result = account_unlock_request.from_json(account_unlock_request) + api_response = api_instance.unlock_account(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.unlock_account(id, Result) + print("The response of AccountsApi->unlock_account:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) /accounts/search-attribute-config: post: operationId: createSearchAttributeConfig @@ -5851,6 +6564,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#create-search-attribute-config + source: | + search_attribute_config = { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } # SearchAttributeConfig | + try: + # Create Extended Search Attributes + Result = search_attribute_config.from_json(search_attribute_config) + api_response = api_instance.create_search_attribute_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_search_attribute_config(Result) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) get: operationId: getSearchAttributeConfig security: @@ -5903,6 +6638,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + try: + # List Extended Search Attributes + + api_response = api_instance.get_search_attribute_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) /accounts/search-attribute-config/{name}: get: operationId: getSingleSearchAttributeConfig @@ -5972,6 +6721,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + 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 + + api_response = api_instance.get_single_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) delete: operationId: deleteSearchAttributeConfig security: @@ -6031,6 +6795,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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 + + api_instance.delete_search_attribute_config(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) patch: operationId: patchSearchAttributeConfig security: @@ -6124,6 +6901,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_search_attribute_config(name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_search_attribute_config(name, Result) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) /account-activities: get: operationId: listAccountActivities @@ -6325,6 +7124,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-activities#list-account-activities + source: | + 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 + + api_response = api_instance.list_account_activities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) /account-activities/{id}: get: operationId: getAccountActivity @@ -6384,6 +7205,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-activities#get-account-activity + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + api_response = api_instance.get_account_activity(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) /auth-org/network-config: get: operationId: getAuthOrgNetworkConfig @@ -6460,6 +7296,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + try: + # Get security network configuration. + + api_response = api_instance.get_auth_org_network_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) post: operationId: createAuthOrgNetworkConfig tags: @@ -6532,6 +7382,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + 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. + Result = network_configuration.from_json(network_configuration) + api_response = api_instance.create_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) patch: operationId: patchAuthOrgNetworkConfig tags: @@ -6618,6 +7487,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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. + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_network_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_network_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) /auth-org/lockout-config: get: operationId: getAuthOrgLockoutConfig @@ -6685,6 +7575,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + try: + # Get Auth Org Lockout Configuration. + + api_response = api_instance.get_auth_org_lockout_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) patch: operationId: patchAuthOrgLockoutConfig tags: @@ -6769,6 +7673,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + [{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` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_lockout_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_lockout_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) /auth-org/service-provider-config: get: operationId: getAuthOrgServiceProviderConfig @@ -6977,6 +7902,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + try: + # Get Service Provider Configuration. + + api_response = api_instance.get_auth_org_service_provider_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) patch: operationId: patchAuthOrgServiceProviderConfig tags: @@ -7099,6 +8038,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_service_provider_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_service_provider_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) /auth-org/session-config: get: operationId: getAuthOrgSessionConfig @@ -7166,6 +8126,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + try: + # Get Auth Org Session Configuration. + + api_response = api_instance.get_auth_org_session_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) patch: operationId: patchAuthOrgSessionConfig tags: @@ -7252,6 +8226,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + [{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.` + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_org_session_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_org_session_config(Result) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) /auth-users/{id}: get: operationId: getAuthUser @@ -7424,6 +8419,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/auth-users#get-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + api_response = api_instance.get_auth_user(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) patch: operationId: patchAuthUser tags: @@ -7512,6 +8522,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/auth-users#patch-auth-user + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_auth_user(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_auth_user(id, Result) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) /brandings: get: operationId: getBrandingList @@ -7606,6 +8638,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#get-branding-list + source: | + try: + # List of branding items + + api_response = api_instance.get_branding_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) post: operationId: createBrandingItem tags: @@ -7710,6 +8756,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#create-branding-item + source: | + 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 + + api_response = api_instance.create_branding_item(name, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) /brandings/{name}: get: operationId: getBranding @@ -7776,6 +8844,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#get-branding + source: | + 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 + + api_response = api_instance.get_branding(name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) put: operationId: setBrandingItem tags: @@ -7856,6 +8939,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#set-branding-item + source: | + 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 + + api_response = api_instance.set_branding_item(name, name2, product_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) delete: operationId: deleteBranding tags: @@ -7917,6 +9023,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#delete-branding + source: | + 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 + + api_instance.delete_branding(name) + + # Below is a request that includes all optional parameters + # api_instance.delete_branding(name) + except Exception as e: + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) /campaigns: get: operationId: getActiveCampaigns @@ -8548,6 +9667,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-active-campaigns + source: | + 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 + + api_response = api_instance.get_active_campaigns() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) post: operationId: createCampaign tags: @@ -8961,6 +10100,129 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign + source: | + 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 + Result = campaign.from_json(campaign) + api_response = api_instance.create_campaign(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign(Result) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) /campaigns/{id}: get: operationId: getCampaign @@ -9088,6 +10350,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign + source: | + 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 + + api_response = api_instance.get_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) patch: operationId: updateCampaign tags: @@ -9204,6 +10482,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#update-campaign + source: | + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_campaign(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign(id, Result) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) /campaigns/{id}/reassign: post: security: @@ -9391,6 +10691,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#move + source: | + 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 + Result = admin_review_reassign.from_json(admin_review_reassign) + api_response = api_instance.move(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.move(id, Result) + print("The response of CertificationCampaignsApi->move:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) /campaigns/{id}/activate: post: operationId: startCampaign @@ -9471,6 +10794,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign + source: | + 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 + + api_response = api_instance.start_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign(id, Result) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) /campaigns/{id}/complete: post: operationId: completeCampaign @@ -9563,6 +10904,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#complete-campaign + source: | + 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 + + api_response = api_instance.complete_campaign(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_campaign(id, Result) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) /campaigns/delete: post: operationId: deleteCampaigns @@ -9637,6 +10996,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaigns + source: | + campaigns_delete_request = { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + Result = campaigns_delete_request.from_json(campaigns_delete_request) + api_response = api_instance.delete_campaigns(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_campaigns(Result) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) /campaigns/{id}/run-remediation-scan: post: operationId: startCampaignRemediationScan @@ -9700,6 +11076,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 + + api_response = api_instance.start_campaign_remediation_scan(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) /campaigns/{id}/reports: get: operationId: getCampaignReports @@ -9792,6 +11183,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports + source: | + 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 + + api_response = api_instance.get_campaign_reports(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) /campaigns/{id}/run-report/{type}: post: operationId: startCampaignReport @@ -9869,6 +11275,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-report + source: | + 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 + + api_response = api_instance.start_campaign_report(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) /campaigns/reports-configuration: get: operationId: getCampaignReportsConfig @@ -9933,6 +11355,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports-config + source: | + try: + # Get Campaign Reports Configuration + + api_response = api_instance.get_campaign_reports_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) put: operationId: setCampaignReportsConfig tags: @@ -9999,6 +11435,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-reports-config + source: | + campaign_reports_config = { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + Result = campaign_reports_config.from_json(campaign_reports_config) + api_response = api_instance.set_campaign_reports_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_campaign_reports_config(Result) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) /campaign-filters: post: operationId: createCampaignFilter @@ -10173,6 +11626,38 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#create-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.create_campaign_filter(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_filter(Result) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) get: operationId: listCampaignFilters tags: @@ -10292,6 +11777,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#list-campaign-filters + 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) + 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 + + api_response = api_instance.list_campaign_filters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) /campaign-filters/{id}: get: operationId: getCampaignFilterById @@ -10354,6 +11856,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + 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 + + api_response = api_instance.get_campaign_filter_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) post: operationId: updateCampaignFilter tags: @@ -10441,6 +11958,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#update-campaign-filter + source: | + 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 + Result = campaign_filter_details.from_json(campaign_filter_details) + api_response = api_instance.update_campaign_filter(filter_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_campaign_filter(filter_id, Result) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) /campaign-filters/delete: post: operationId: deleteCampaignFilters @@ -10505,6 +12055,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#delete-campaign-filters + source: | + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete. + + try: + # Deletes Campaign Filters + Result = request_body.from_json(request_body) + api_instance.delete_campaign_filters(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_filters(Result) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) /campaign-templates: post: operationId: createCampaignTemplate @@ -11015,6 +12580,144 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign-template + source: | + 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 + Result = campaign_template.from_json(campaign_template) + api_response = api_instance.create_campaign_template(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_campaign_template(Result) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) get: operationId: getCampaignTemplates tags: @@ -11274,6 +12977,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-templates + 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 = '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 + + api_response = api_instance.get_campaign_templates() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) /campaign-templates/{id}: patch: operationId: patchCampaignTemplate @@ -11384,6 +13106,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#patch-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + [{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) + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_campaign_template(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_campaign_template(id, Result) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) get: operationId: getCampaignTemplate tags: @@ -11463,6 +13207,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + api_response = api_instance.get_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) delete: operationId: deleteCampaignTemplate tags: @@ -11524,6 +13283,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + api_instance.delete_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) /campaign-templates/{id}/schedule: get: operationId: getCampaignTemplateSchedule @@ -11752,6 +13524,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 + + api_response = api_instance.get_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) put: operationId: setCampaignTemplateSchedule tags: @@ -11907,6 +13694,39 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 + + api_instance.set_campaign_template_schedule(id, ) + + # Below is a request that includes all optional parameters + # api_instance.set_campaign_template_schedule(id, Result) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) delete: operationId: deleteCampaignTemplateSchedule tags: @@ -11967,6 +13787,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 + + api_instance.delete_campaign_template_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) /campaign-templates/{id}/generate: post: operationId: startGenerateCampaignTemplate @@ -12040,6 +13873,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 + + api_response = api_instance.start_generate_campaign_template(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) /certifications: get: operationId: listIdentityCertifications @@ -12212,6 +14060,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-certifications + source: | + 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 + + api_response = api_instance.list_identity_certifications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) /certifications/{id}: get: operationId: getIdentityCertification @@ -12276,6 +14144,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + api_response = api_instance.get_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) /certifications/{id}/access-review-items: get: operationId: listIdentityAccessReviewItems @@ -12457,6 +14340,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-access-review-items + source: | + 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 + + api_response = api_instance.list_identity_access_review_items(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.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") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) /certifications/{id}/decide: post: operationId: makeIdentityDecision @@ -12601,6 +14507,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#make-identity-decision + source: | + 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 + [{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. + review_decision = { + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + } # List[ReviewDecision] | A non-empty array of decisions to be made. + + try: + # Decide on a Certification Item + Result = review_decision.from_json(review_decision) + api_response = api_instance.make_identity_decision(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.make_identity_decision(id, Result) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) /certifications/{id}/reassign: post: operationId: reassignIdentityCertifications @@ -12698,6 +14633,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#reassign-identity-certifications + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.reassign_identity_certifications(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reassign_identity_certifications(id, Result) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) /certifications/{id}/sign-off: post: operationId: signOffIdentityCertification @@ -12762,6 +14723,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#sign-off-identity-certification + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + api_response = api_instance.sign_off_identity_certification(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) /certifications/{id}/decision-summary: get: operationId: getIdentityDecisionSummary @@ -12919,6 +14895,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + 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 + + api_response = api_instance.get_identity_decision_summary(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) /certifications/{id}/identity-summaries: get: operationId: getIdentitySummaries @@ -13048,6 +15040,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + 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 + + api_response = api_instance.get_identity_summaries(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) /certifications/{id}/access-summaries/{type}: get: operationId: getIdentityAccessSummaries @@ -13516,6 +15528,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + 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 + + api_response = api_instance.get_identity_access_summaries(id, type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) /certifications/{id}/identity-summaries/{identitySummaryId}: get: operationId: getIdentitySummary @@ -13589,6 +15622,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + 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 + + api_response = api_instance.get_identity_summary(id, identity_summary_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) /certifications/{certificationId}/access-review-items/{itemId}/permissions: get: operationId: getIdentityCertificationItemPermissions @@ -13711,6 +15760,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification-item-permissions + source: | + 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 + + api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) /certifications/{id}/reviewers: get: operationId: listCertificationReviewers @@ -13814,6 +15883,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-certification-reviewers + source: | + 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 + + api_response = api_instance.list_certification_reviewers(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) /certifications/{id}/reassign-async: post: operationId: submitReassignCertsAsync @@ -13905,6 +15994,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#submit-reassign-certs-async + source: | + 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 + Result = review_reassign.from_json(review_reassign) + api_response = api_instance.submit_reassign_certs_async(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_reassign_certs_async(id, Result) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) /certification-tasks/{id}: get: operationId: getCertificationTask @@ -13970,6 +16085,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-certification-task + source: | + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + api_response = api_instance.get_certification_task(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) /certification-tasks: get: operationId: getPendingCertificationTasks @@ -14058,6 +16188,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-pending-certification-tasks + source: | + 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 + + api_response = api_instance.get_pending_certification_tasks() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}: get: operationId: getObjectMappings @@ -14204,6 +16353,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-object-mappings + source: | + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + api_response = api_instance.get_object_mappings(source_org) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) post: operationId: createObjectMapping security: @@ -14355,6 +16519,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mapping + source: | + 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 + Result = object_mapping_request.from_json(object_mapping_request) + api_response = api_instance.create_object_mapping(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mapping(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}: delete: operationId: deleteObjectMapping @@ -14424,6 +16610,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-object-mapping + source: | + 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 + + api_instance.delete_object_mapping(source_org, object_mapping_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_object_mapping(source_org, object_mapping_id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}/bulk-create: post: operationId: createObjectMappings @@ -14559,6 +16759,36 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mappings + source: | + 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 + Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request) + api_response = api_instance.create_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) /configuration-hub/object-mappings/{sourceOrg}/bulk-patch: post: operationId: updateObjectMappings @@ -14703,6 +16933,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#update-object-mappings + source: | + 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 + Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request) + api_response = api_instance.update_object_mappings(source_org, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_object_mappings(source_org, Result) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) /configuration-hub/backups/uploads: get: operationId: listUploadedConfigurations @@ -14935,6 +17194,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#list-uploaded-configurations + source: | + 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 + + api_response = api_instance.list_uploaded_configurations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) post: operationId: createUploadedConfiguration security: @@ -15094,6 +17368,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-uploaded-configuration + source: | + 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 + + api_response = api_instance.create_uploaded_configuration(data, name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) /configuration-hub/backups/uploads/{id}: get: operationId: getUploadedConfiguration @@ -15172,6 +17462,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-uploaded-configuration + source: | + 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 + + api_response = api_instance.get_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) delete: operationId: deleteUploadedConfiguration security: @@ -15233,6 +17538,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-uploaded-configuration + source: | + 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 + + api_instance.delete_uploaded_configuration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_uploaded_configuration(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) /connectors/{scriptName}: get: tags: @@ -15453,6 +17771,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector + source: | + 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 + + api_response = api_instance.get_connector(script_name, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) delete: tags: - Connectors @@ -15516,6 +17850,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#delete-custom-connector + source: | + 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 + + api_instance.delete_custom_connector(script_name) + + # Below is a request that includes all optional parameters + # api_instance.delete_custom_connector(script_name) + except Exception as e: + print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) patch: tags: - Connectors @@ -15613,6 +17960,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#update-connector + source: | + 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. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | A list of connector detail update operations + + try: + # Update Connector by Script Name + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_connector(script_name, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_connector(script_name, Result) + print("The response of ConnectorsApi->update_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) /connectors: get: tags: @@ -15784,6 +18153,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-list + source: | + 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 + + api_response = api_instance.get_connector_list() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) post: tags: - Connectors @@ -15885,6 +18273,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#create-custom-connector + source: | + v3_create_connector_dto = { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } # V3CreateConnectorDto | + try: + # Create Custom Connector + Result = v3_create_connector_dto.from_json(v3_create_connector_dto) + api_response = api_instance.create_custom_connector(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_custom_connector(Result) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) /connectors/{scriptName}/source-config: get: tags: @@ -15953,6 +18362,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-config + source: | + 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 + + api_response = api_instance.get_connector_source_config(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) put: tags: - Connectors @@ -16059,6 +18483,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-config + source: | + 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 + + api_response = api_instance.put_connector_source_config(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) /connectors/{scriptName}/translations/{locale}: get: tags: @@ -16155,6 +18595,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-translations + source: | + 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 + + api_response = api_instance.get_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) put: tags: - Connectors @@ -16256,6 +18712,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-translations + source: | + 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 + + api_response = api_instance.put_connector_translations(script_name, locale) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) /connectors/{scriptName}/source-template: get: tags: @@ -16324,6 +18796,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-template + source: | + 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 + + api_response = api_instance.get_connector_source_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) put: tags: - Connectors @@ -16405,6 +18892,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-template + source: | + 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 + + api_response = api_instance.put_connector_source_template(script_name, file) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) /identities/{identity-id}/set-lifecycle-state: post: operationId: setLifecycleState @@ -16488,6 +18991,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#set-lifecycle-state + source: | + 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 + Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request) + api_response = api_instance.set_lifecycle_state(identity_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_lifecycle_state(identity_id, Result) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) /identity-profiles/{identity-profile-id}/lifecycle-states: get: operationId: getLifecycleStates @@ -16661,6 +19180,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-states + source: | + 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 + + api_response = api_instance.get_lifecycle_states(identity_profile_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) post: operationId: createLifecycleState tags: @@ -16759,6 +19297,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#create-lifecycle-state + source: | + 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 + Result = lifecycle_state.from_json(lifecycle_state) + api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}: get: operationId: getLifecycleState @@ -16832,6 +19410,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-state + source: | + 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 + + api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) patch: operationId: updateLifecycleStates tags: @@ -16957,6 +19551,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#update-lifecycle-states + source: | + 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. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) delete: operationId: deleteLifecycleState tags: @@ -17046,6 +19663,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#delete-lifecycle-state + source: | + 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 + + api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) /identity-profiles: get: operationId: listIdentityProfiles @@ -17212,6 +19845,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#list-identity-profiles + 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) + 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 + + api_response = api_instance.list_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) post: operationId: createIdentityProfile summary: Create Identity Profile @@ -17321,6 +19973,69 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#create-identity-profile + source: | + 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 + Result = identity_profile.from_json(identity_profile) + api_response = api_instance.create_identity_profile(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_identity_profile(Result) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) /identity-profiles/bulk-delete: post: operationId: deleteIdentityProfiles @@ -17430,6 +20145,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profiles + source: | + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. + + try: + # Delete Identity Profiles + Result = request_body.from_json(request_body) + api_response = api_instance.delete_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profiles(Result) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) /identity-profiles/export: get: operationId: exportIdentityProfiles @@ -17570,6 +20302,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#export-identity-profiles + 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) + 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 + + api_response = api_instance.export_identity_profiles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) /identity-profiles/import: post: operationId: importIdentityProfiles @@ -17765,6 +20516,79 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#import-identity-profiles + source: | + [sailpoint.v3.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + identity_profile_exported_object = { + "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" + } + } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + + try: + # Import Identity Profiles + Result = identity_profile_exported_object.from_json(identity_profile_exported_object) + api_response = api_instance.import_identity_profiles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_identity_profiles(Result) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) /identity-profiles/identity-preview: post: operationId: showIdentityPreview @@ -17903,6 +20727,47 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#show-identity-preview + source: | + 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 + Result = identity_preview_request.from_json(identity_preview_request) + api_response = api_instance.show_identity_preview(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.show_identity_preview(Result) + print("The response of IdentityProfilesApi->show_identity_preview:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e) /identity-profiles/{identity-profile-id}: get: operationId: getIdentityProfile @@ -17970,6 +20835,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-identity-profile + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + api_response = api_instance.get_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) delete: operationId: deleteIdentityProfile tags: @@ -18036,6 +20916,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + api_response = api_instance.delete_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) patch: operationId: updateIdentityProfile tags: @@ -18140,6 +21035,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#update-identity-profile + source: | + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Update Identity Profile + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_identity_profile(identity_profile_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_identity_profile(identity_profile_id, Result) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) /identity-profiles/{identity-profile-id}/default-identity-attribute-config: get: operationId: getDefaultIdentityAttributeConfig @@ -18205,6 +21122,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-default-identity-attribute-config + source: | + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) /identity-profiles/{identity-profile-id}/process-identities: post: operationId: syncIdentityProfile @@ -18274,6 +21206,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#sync-identity-profile + source: | + 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 + + api_response = api_instance.sync_identity_profile(identity_profile_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) /managed-clients: get: tags: @@ -18498,6 +21445,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + 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 + + api_response = api_instance.get_managed_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) post: tags: - Managed Clients @@ -18588,6 +21553,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + managed_client_request = { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } # ManagedClientRequest | + try: + # Create Managed Client + Result = managed_client_request.from_json(managed_client_request) + api_response = api_instance.create_managed_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_client(Result) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) /managed-clients/{id}: get: tags: @@ -18655,6 +21640,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + api_response = api_instance.get_managed_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) patch: tags: - Managed Clients @@ -18735,6 +21735,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Client + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_client(id, Result) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) delete: operationId: deleteManagedClient tags: @@ -18791,6 +21813,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + api_instance.delete_managed_client(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) /managed-clients/{id}/status: get: tags: @@ -18923,6 +21958,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + 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 + + api_response = api_instance.get_managed_client_status(id, type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) /managed-clusters: get: tags: @@ -19173,6 +22224,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + 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 + + api_response = api_instance.get_managed_clusters() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) post: tags: - Managed Clusters @@ -19268,6 +22337,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + 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 + Result = managed_cluster_request.from_json(managed_cluster_request) + api_response = api_instance.create_managed_cluster(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_managed_cluster(Result) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) /managed-clusters/{id}: get: tags: @@ -19335,6 +22427,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + api_response = api_instance.get_managed_cluster(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) patch: tags: - Managed Clusters @@ -19415,6 +22522,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + [sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | JSONPatch payload used to update the object. + + try: + # Update Managed Cluster + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_managed_cluster(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_managed_cluster(id, Result) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) delete: operationId: deleteManagedCluster tags: @@ -19480,6 +22609,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + 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 + + api_instance.delete_managed_cluster(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) /managed-clusters/{id}/log-config: get: tags: @@ -19591,6 +22734,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + 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 + + api_response = api_instance.get_client_log_configuration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) put: tags: - Managed Clusters @@ -19732,6 +22890,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + 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 + Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request) + api_response = api_instance.put_client_log_configuration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_client_log_configuration(id, Result) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) /mfa/okta-verify/config: get: operationId: getMFAOktaConfig @@ -19815,6 +22989,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-okta-config + source: | + try: + # Configuration of Okta MFA method + + api_response = api_instance.get_mfa_okta_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) put: operationId: setMFAOktaConfig tags: @@ -19894,6 +23082,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-okta-config + source: | + mfa_okta_config = { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } # MfaOktaConfig | + try: + # Set Okta MFA configuration + Result = mfa_okta_config.from_json(mfa_okta_config) + api_response = api_instance.set_mfa_okta_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_okta_config(Result) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) /mfa/duo-web/config: get: operationId: getMFADuoConfig @@ -19988,6 +23197,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-duo-config + source: | + try: + # Configuration of Duo MFA method + + api_response = api_instance.get_mfa_duo_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) put: operationId: setMFADuoConfig tags: @@ -20077,6 +23300,31 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-duo-config + source: | + 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 + Result = mfa_duo_config.from_json(mfa_duo_config) + api_response = api_instance.set_mfa_duo_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfa_duo_config(Result) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) /mfa/kba/config: get: operationId: getMFAKbaConfig @@ -20180,6 +23428,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-kba-config + source: | + 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 + + api_response = api_instance.get_mfa_kba_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) /mfa/kba/config/answers: post: operationId: setMFAKBAConfig @@ -20295,6 +23558,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfakba-config + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Set MFA KBA configuration + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.set_mfakba_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_mfakba_config(Result) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) /mfa/{method}/test: get: operationId: testMFAConfig @@ -20377,6 +23660,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#test-mfa-config + source: | + 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 + + api_response = api_instance.test_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) /mfa/{method}/delete: delete: operationId: deleteMFAConfig @@ -20447,6 +23745,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#delete-mfa-config + source: | + 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 + + api_response = api_instance.delete_mfa_config(method) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) /mfa/okta-verify/verify: post: operationId: sendOktaVerifyRequest @@ -20542,6 +23855,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-okta-verify-request + source: | + okta_verification_request = { + "userId" : "example@mail.com" + } # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + Result = okta_verification_request.from_json(okta_verification_request) + api_response = api_instance.send_okta_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_okta_verify_request(Result) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) /mfa/duo-web/verify: post: operationId: sendDuoVerifyRequest @@ -20625,6 +23955,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-duo-verify-request + source: | + duo_verification_request = { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + Result = duo_verification_request.from_json(duo_verification_request) + api_response = api_instance.send_duo_verify_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_duo_verify_request(Result) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) /mfa/{method}/poll: post: operationId: pingVerificationStatus @@ -20718,6 +24066,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#ping-verification-status + source: | + 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 + Result = verification_poll_request.from_json(verification_poll_request) + api_response = api_instance.ping_verification_status(method, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.ping_verification_status(method, Result) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) /mfa/kba/authenticate: post: operationId: sendKbaAnswers @@ -20823,6 +24189,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-kba-answers + source: | + [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | + kba_answer_request_item = { + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + } # List[KbaAnswerRequestItem] | + + try: + # Authenticate KBA provided MFA method + Result = kba_answer_request_item.from_json(kba_answer_request_item) + api_response = api_instance.send_kba_answers(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_kba_answers(Result) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) /mfa/token/authenticate: post: operationId: sendTokenAuthRequest @@ -20929,6 +24315,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-token-auth-request + source: | + token_auth_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + Result = token_auth_request.from_json(token_auth_request) + api_response = api_instance.send_token_auth_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.send_token_auth_request(Result) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) /mfa/token/send: post: operationId: createSendToken @@ -21036,6 +24441,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#create-send-token + source: | + send_token_request = { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } # SendTokenRequest | + try: + # Create and send user token + Result = send_token_request.from_json(send_token_request) + api_response = api_instance.create_send_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_send_token(Result) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) /non-employee-records: post: operationId: createNonEmployeeRecord @@ -21224,6 +24647,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_record(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_record(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) get: operationId: listNonEmployeeRecords security: @@ -21311,6 +24762,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-records + 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 = '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 + + api_response = api_instance.list_non_employee_records() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) /non-employee-records/{id}: get: operationId: getNonEmployeeRecord @@ -21369,6 +24839,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + api_response = api_instance.get_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) put: operationId: updateNonEmployeeRecord security: @@ -21459,6 +24944,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.update_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) patch: operationId: patchNonEmployeeRecord security: @@ -21545,6 +25059,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_record(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_record(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) delete: operationId: deleteNonEmployeeRecord tags: @@ -21598,6 +25134,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + api_instance.delete_non_employee_record(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_record(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) /non-employee-records/bulk-delete: post: operationId: deleteNonEmployeeRecordsInBulk @@ -21663,6 +25212,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + delete_non_employee_records_in_bulk_request = sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + api_instance.delete_non_employee_records_in_bulk(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_records_in_bulk(Result) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) /non-employee-requests: post: operationId: createNonEmployeeRequest @@ -21893,6 +25455,34 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + 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 + Result = non_employee_request_body.from_json(non_employee_request_body) + api_response = api_instance.create_non_employee_request(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_request(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) get: operationId: listNonEmployeeRequests security: @@ -21990,6 +25580,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + 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 + + api_response = api_instance.list_non_employee_requests(requested_for, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) /non-employee-requests/{id}: get: operationId: getNonEmployeeRequest @@ -22056,6 +25666,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + api_response = api_instance.get_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) delete: operationId: deleteNonEmployeeRequest tags: @@ -22113,6 +25738,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + 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 + + api_instance.delete_non_employee_request(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) /non-employee-requests/summary/{requested-for}: get: operationId: getNonEmployeeRequestSummary @@ -22197,6 +25835,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + 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 + + api_response = api_instance.get_non_employee_request_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) /non-employee-sources: post: operationId: createNonEmployeeSource @@ -22332,6 +25985,46 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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 + Result = non_employee_source_request_body.from_json(non_employee_source_request_body) + api_response = api_instance.create_non_employee_source(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source(Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) get: operationId: listNonEmployeeSources security: @@ -22435,6 +26128,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-sources + 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) + 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 + + api_response = api_instance.list_non_employee_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) /non-employee-sources/{sourceId}: get: operationId: getNonEmployeeSource @@ -22534,6 +26247,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + api_response = api_instance.get_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) patch: operationId: patchNonEmployeeSource tags: @@ -22616,6 +26344,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_source(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_source(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) delete: operationId: deleteNonEmployeeSource tags: @@ -22667,6 +26417,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + api_instance.delete_non_employee_source(source_id) + + # Below is a request that includes all optional parameters + # api_instance.delete_non_employee_source(source_id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) /non-employee-sources/{id}/non-employees/download: get: operationId: exportNonEmployeeRecords @@ -22727,6 +26490,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + api_instance.export_non_employee_records(id) + + # Below is a request that includes all optional parameters + # api_instance.export_non_employee_records(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) /non-employee-sources/{id}/non-employee-bulk-upload: post: operationId: importNonEmployeeRecordsInBulk @@ -22839,6 +26615,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + api_response = api_instance.import_non_employee_records_in_bulk(id, data) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) /non-employee-sources/{id}/non-employee-bulk-upload/status: get: operationId: getNonEmployeeBulkUploadStatus @@ -22912,6 +26704,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + api_response = api_instance.get_non_employee_bulk_upload_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) /non-employee-sources/{id}/schema-attributes-template/download: get: operationId: exportNonEmployeeSourceSchemaTemplate @@ -22970,6 +26777,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + api_instance.export_non_employee_source_schema_template(id) + + # Below is a request that includes all optional parameters + # api_instance.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) /non-employee-approvals: get: operationId: listNonEmployeeApprovals @@ -23086,6 +26906,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + 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 + + api_response = api_instance.list_non_employee_approvals() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) /non-employee-approvals/{id}: get: operationId: getNonEmployeeApproval @@ -23240,6 +27080,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + 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 + + api_response = api_instance.get_non_employee_approval(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) /non-employee-approvals/{id}/approve: post: operationId: approveNonEmployeeRequest @@ -23316,6 +27172,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + 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 + Result = non_employee_approval_decision.from_json(non_employee_approval_decision) + api_response = api_instance.approve_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) /non-employee-approvals/{id}/reject: post: operationId: rejectNonEmployeeRequest @@ -23394,6 +27268,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + 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 + Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + api_response = api_instance.reject_non_employee_request(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_non_employee_request(id, Result) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) /non-employee-approvals/summary/{requested-for}: get: operationId: getNonEmployeeApprovalSummary @@ -23472,6 +27364,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + 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 + + api_response = api_instance.get_non_employee_approval_summary(requested_for) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) /non-employee-sources/{sourceId}/schema-attributes: get: operationId: getNonEmployeeSourceSchemaAttributes @@ -23591,6 +27498,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) post: operationId: createNonEmployeeSourceSchemaAttributes tags: @@ -23694,6 +27616,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + 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 + Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) delete: operationId: deleteNonEmployeeSourceSchemaAttributes tags: @@ -23745,6 +27690,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + api_instance.delete_non_employee_source_schema_attributes(source_id) + + # Below is a request that includes all optional parameters + # api_instance.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) /non-employee-sources/{sourceId}/schema-attributes/{attributeId}: get: operationId: getNonEmployeeSchemaAttribute @@ -23812,6 +27770,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + 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 + + api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) patch: operationId: patchNonEmployeeSchemaAttribute tags: @@ -23903,6 +27877,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + 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 + [{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'. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) delete: operationId: deleteNonEmployeeSchemaAttribute tags: @@ -23965,6 +27962,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + 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 + + api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + + # Below is a request that includes all optional parameters + # api_instance.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) /oauth-clients: get: operationId: listOauthClients @@ -24167,6 +28178,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#list-oauth-clients + source: | + 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 + + api_response = api_instance.list_oauth_clients() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) post: operationId: createOauthClient security: @@ -24443,6 +28469,37 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#create-oauth-client + source: | + 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 + Result = create_o_auth_client_request.from_json(create_o_auth_client_request) + api_response = api_instance.create_oauth_client(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_oauth_client(Result) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) /oauth-clients/{id}: get: operationId: getOauthClient @@ -24506,6 +28563,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#get-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + api_response = api_instance.get_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) delete: operationId: deleteOauthClient security: @@ -24562,6 +28634,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#delete-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + api_instance.delete_oauth_client(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_oauth_client(id) + except Exception as e: + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) patch: operationId: patchOauthClient security: @@ -24663,6 +28748,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#patch-oauth-client + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_oauth_client(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_oauth_client(id, Result) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) /password-sync-groups: get: operationId: getPasswordSyncGroups @@ -24758,6 +28865,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-groups + 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) + try: + # Get Password Sync Group List + + api_response = api_instance.get_password_sync_groups() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) post: operationId: createPasswordSyncGroup tags: @@ -24839,6 +28963,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#create-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.create_password_sync_group(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_sync_group(Result) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) /password-sync-groups/{id}: get: operationId: getPasswordSyncGroup @@ -24910,6 +29056,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-group + source: | + 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 + + api_response = api_instance.get_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) put: operationId: updatePasswordSyncGroup tags: @@ -25005,6 +29166,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#update-password-sync-group + source: | + 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 + Result = password_sync_group.from_json(password_sync_group) + api_response = api_instance.update_password_sync_group(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_password_sync_group(id, Result) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) delete: operationId: deletePasswordSyncGroup tags: @@ -25061,6 +29245,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#delete-password-sync-group + source: | + 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 + + api_instance.delete_password_sync_group(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_password_sync_group(id) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) /password-policies/{id}: get: operationId: getPasswordPolicyById @@ -25310,6 +29507,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#get-password-policy-by-id + source: | + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + api_response = api_instance.get_password_policy_by_id(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) put: operationId: setPasswordPolicy tags: @@ -25480,6 +29692,54 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#set-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.set_password_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password_policy(id, Result) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) delete: operationId: deletePasswordPolicy tags: @@ -25539,6 +29799,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#delete-password-policy + source: | + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + api_instance.delete_password_policy(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_password_policy(id) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) /password-policies: post: operationId: createPasswordPolicy @@ -25668,6 +29941,53 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#create-password-policy + source: | + 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 + Result = password_policy_v3_dto.from_json(password_policy_v3_dto) + api_response = api_instance.create_password_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_policy(Result) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) get: operationId: listPasswordPolicies tags: @@ -25791,6 +30111,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#list-password-policies + 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) + try: + # List Password Policies + + api_response = api_instance.list_password_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) /personal-access-tokens: get: operationId: listPersonalAccessTokens @@ -25929,6 +30266,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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 + + api_response = api_instance.list_personal_access_tokens() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) post: operationId: createPersonalAccessToken security: @@ -26069,6 +30422,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#create-personal-access-token + source: | + 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 + Result = create_personal_access_token_request.from_json(create_personal_access_token_request) + api_response = api_instance.create_personal_access_token(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_personal_access_token(Result) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) /personal-access-tokens/{id}: patch: operationId: patchPersonalAccessToken @@ -26163,6 +30535,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#patch-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_personal_access_token(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_personal_access_token(id, Result) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) delete: operationId: deletePersonalAccessToken security: @@ -26220,6 +30614,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#delete-personal-access-token + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + api_instance.delete_personal_access_token(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_personal_access_token(id) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) /public-identities: get: operationId: getPublicIdentities @@ -26437,6 +30844,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities#get-public-identities + 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) + 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 + + api_response = api_instance.get_public_identities() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) /public-identities-config: get: operationId: getPublicIdentityConfig @@ -26512,6 +30939,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities-config#get-public-identity-config + source: | + try: + # Get the Public Identities Configuration + + api_response = api_instance.get_public_identity_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) put: operationId: updatePublicIdentityConfig tags: @@ -26586,6 +31027,35 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities-config#update-public-identity-config + source: | + 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 + Result = public_identity_config.from_json(public_identity_config) + api_response = api_instance.update_public_identity_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_public_identity_config(Result) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) /requestable-objects: get: operationId: listRequestableObjects @@ -26771,6 +31241,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/requestable-objects#list-requestable-objects + source: | + 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. Support for additional types may be added in the future without notice. (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. Support for additional types may be added in the future without notice. (optional) + term = 'Finance Role' # str | 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) # str | 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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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 = [sailpoint.v3.RequestableObjectRequestStatus()] # List[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) + 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 + + api_response = api_instance.list_requestable_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) /roles: get: operationId: listRoles @@ -27277,6 +31774,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#list-roles + source: | + 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 + + api_response = api_instance.list_roles() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) post: operationId: createRole tags: @@ -27502,6 +32021,178 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/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 + } # Role | + try: + # Create a Role + Result = role.from_json(role) + api_response = api_instance.create_role(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_role(Result) + print("The response of RolesApi->create_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) /roles/{id}: get: operationId: getRole @@ -27570,6 +32261,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#get-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + api_response = api_instance.get_role(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) patch: operationId: patchRole tags: @@ -27747,6 +32453,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#patch-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch a specified Role + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_role(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_role(id, Result) + print("The response of RolesApi->patch_role:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) delete: operationId: deleteRole tags: @@ -27809,6 +32537,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#delete-role + source: | + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + api_instance.delete_role(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) /roles/bulk-delete: post: operationId: deleteBulkRoles @@ -27946,6 +32687,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#delete-bulk-roles + source: | + role_bulk_delete_request = { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } # RoleBulkDeleteRequest | + try: + # Delete Role(s) + Result = role_bulk_delete_request.from_json(role_bulk_delete_request) + api_response = api_instance.delete_bulk_roles(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_bulk_roles(Result) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) /roles/{id}/assigned-identities: get: operationId: getRoleAssignedIdentities @@ -28071,6 +32829,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#get-role-assigned-identities + source: | + 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 + + api_response = api_instance.get_role_assigned_identities(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) /saved-searches: post: security: @@ -28161,6 +32939,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#create-saved-search + source: | + create_saved_search_request = sailpoint.v3.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + Result = create_saved_search_request.from_json(create_saved_search_request) + api_response = api_instance.create_saved_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_saved_search(Result) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) get: security: - userAuth: @@ -28240,6 +33033,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#list-saved-searches + source: | + 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 + + api_response = api_instance.list_saved_searches() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) /saved-searches/{id}: put: tags: @@ -28356,6 +33167,66 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#put-saved-search + source: | + 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 + Result = saved_search.from_json(saved_search) + api_response = api_instance.put_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_saved_search(id, Result) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) get: tags: - Saved Search @@ -28415,6 +33286,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#get-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + api_response = api_instance.get_saved_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) delete: tags: - Saved Search @@ -28469,6 +33355,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#delete-saved-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + api_instance.delete_saved_search(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) /saved-searches/{id}/execute: post: tags: @@ -28586,6 +33485,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#execute-saved-search + source: | + 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 + Result = search_arguments.from_json(search_arguments) + api_instance.execute_saved_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.execute_saved_search(id, Result) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) /scheduled-searches: post: tags: @@ -28793,6 +33716,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#create-scheduled-search + source: | + 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 + Result = create_scheduled_search_request.from_json(create_scheduled_search_request) + api_response = api_instance.create_scheduled_search(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_scheduled_search(Result) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) get: tags: - Scheduled Search @@ -28874,6 +33812,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#list-scheduled-search + source: | + 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 + + api_response = api_instance.list_scheduled_search() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) /scheduled-searches/{id}: put: tags: @@ -28988,6 +33944,64 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#update-scheduled-search + source: | + 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 + Result = scheduled_search.from_json(scheduled_search) + api_response = api_instance.update_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_scheduled_search(id, Result) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) get: tags: - Scheduled Search @@ -29046,6 +34060,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#get-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + api_response = api_instance.get_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) delete: tags: - Scheduled Search @@ -29100,6 +34129,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#delete-scheduled-search + source: | + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + api_instance.delete_scheduled_search(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_scheduled_search(id) + except Exception as e: + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) /scheduled-searches/{id}/unsubscribe: post: tags: @@ -29156,6 +34198,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#unsubscribe-scheduled-search + source: | + 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 + Result = typed_reference.from_json(typed_reference) + api_instance.unsubscribe_scheduled_search(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.unsubscribe_scheduled_search(id, Result) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) /search: post: tags: @@ -31819,6 +36878,140 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_post(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_post(Result, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) /search/count: post: tags: @@ -32000,6 +37193,135 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/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" + } + } + } # Search | + try: + # Count Documents Satisfying a Query + Result = search.from_json(search) + api_instance.search_count(Result) + + # Below is a request that includes all optional parameters + # api_instance.search_count(Result) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) /search/aggregate: post: tags: @@ -32384,6 +37706,140 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/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" + } + } + } # 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 + Result = search.from_json(search) + api_response = api_instance.search_aggregate(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_aggregate(Result, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) /search/{index}/{id}: get: tags: @@ -32977,6 +38433,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search#search-get + source: | + 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 + + api_response = api_instance.search_get(index, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) /segments: post: operationId: createSegment @@ -33172,6 +38644,44 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/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" + } # Segment | + try: + # Create Segment + Result = segment.from_json(segment) + api_response = api_instance.create_segment(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_segment(Result) + print("The response of SegmentsApi->create_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) get: operationId: listSegments security: @@ -33238,6 +38748,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#list-segments + 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) + try: + # List Segments + + api_response = api_instance.list_segments() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) /segments/{id}: get: operationId: getSegment @@ -33306,6 +38833,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#get-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + api_response = api_instance.get_segment(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) delete: operationId: deleteSegment security: @@ -33368,6 +38910,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#delete-segment + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + api_instance.delete_segment(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) patch: operationId: patchSegment security: @@ -33476,6 +39031,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#patch-segment + source: | + 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 + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.patch_segment(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_segment(id, Result) + print("The response of SegmentsApi->patch_segment:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) /service-desk-integrations: get: tags: @@ -33654,6 +39227,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integrations + source: | + 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) + 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 eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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* **type**: *eq, in* **cluster**: *eq, in* (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) + try: + # List existing Service Desk integrations + + api_response = api_instance.get_service_desk_integrations() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) post: tags: - Service Desk Integration @@ -33752,6 +39344,54 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#create-service-desk-integration + source: | + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.create_service_desk_integration(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_service_desk_integration(Result) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) /service-desk-integrations/{id}: get: tags: @@ -33819,6 +39459,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get + try: + # Get a Service Desk integration + + api_response = api_instance.get_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) put: tags: - Service Desk Integration @@ -33929,6 +39584,55 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#put-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + 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\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + Result = service_desk_integration_dto.from_json(service_desk_integration_dto) + api_response = api_instance.put_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) delete: tags: - Service Desk Integration @@ -33989,6 +39693,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#delete-service-desk-integration + source: | + id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete + try: + # Delete a Service Desk integration + + api_instance.delete_service_desk_integration(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_service_desk_integration(id) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) patch: operationId: patchServiceDeskIntegration tags: @@ -34085,6 +39802,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#patch-service-desk-integration + source: | + id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update + patch_service_desk_integration_request = sailpoint.v3.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | 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. + try: + # Patch a Service Desk Integration + Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) + api_response = api_instance.patch_service_desk_integration(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_service_desk_integration(id, Result) + print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) /service-desk-integrations/types: get: tags: @@ -34158,6 +39891,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-types + source: | + try: + # List Service Desk integration types + + api_response = api_instance.get_service_desk_integration_types() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) /service-desk-integrations/templates/{scriptName}: get: tags: @@ -34249,6 +39996,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-template + source: | + script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get + try: + # Service Desk integration template by scriptName + + api_response = api_instance.get_service_desk_integration_template(script_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) /service-desk-integrations/status-check-configuration: get: tags: @@ -34316,6 +40078,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-status-check-details + source: | + try: + # Get the time check configuration + + api_response = api_instance.get_status_check_details() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) put: tags: - Service Desk Integration @@ -34384,6 +40160,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#update-status-check-details + source: | + queued_check_config_details = { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + Result = queued_check_config_details.from_json(queued_check_config_details) + api_response = api_instance.update_status_check_details(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_status_check_details(Result) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) /query-password-info: post: operationId: queryPasswordInfo @@ -34495,6 +40289,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#query-password-info + source: | + password_info_query_dto = { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } # PasswordInfoQueryDTO | + try: + # Query Password Info + Result = password_info_query_dto.from_json(password_info_query_dto) + api_response = api_instance.query_password_info(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.query_password_info(Result) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) /set-password: post: operationId: setPassword @@ -34612,6 +40424,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#set-password + source: | + 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 + Result = password_change_request.from_json(password_change_request) + api_response = api_instance.set_password(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_password(Result) + print("The response of PasswordManagementApi->set_password:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) /password-change-status/{id}: get: operationId: getPasswordChangeStatus @@ -34703,6 +40536,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#get-password-change-status + source: | + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + api_response = api_instance.get_password_change_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) /password-dictionary: get: operationId: getPasswordDictionary @@ -34785,6 +40633,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-dictionary#get-password-dictionary + source: | + try: + # Get Password Dictionary + + api_response = api_instance.get_password_dictionary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) put: operationId: putPasswordDictionary tags: @@ -34876,6 +40738,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-dictionary#put-password-dictionary + source: | + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + api_instance.put_password_dictionary() + + # Below is a request that includes all optional parameters + # api_instance.put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) /password-org-config: get: operationId: getPasswordOrgConfig @@ -34956,6 +40831,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#get-password-org-config + source: | + try: + # Get Password Org Config + + api_response = api_instance.get_password_org_config() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) put: operationId: putPasswordOrgConfig tags: @@ -35031,6 +40920,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#put-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Update Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.put_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_password_org_config(Result) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) post: operationId: createPasswordOrgConfig tags: @@ -35108,6 +41017,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#create-password-org-config + source: | + password_org_config = { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } # PasswordOrgConfig | + try: + # Create Password Org Config + Result = password_org_config.from_json(password_org_config) + api_response = api_instance.create_password_org_config(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_password_org_config(Result) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) /reports/{taskResultId}/result: get: tags: @@ -35244,6 +41173,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report-result + source: | + 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 + + api_response = api_instance.get_report_result(task_result_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) /reports/run: post: tags: @@ -35678,6 +41623,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#start-report + source: | + report_details = { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } # ReportDetails | + try: + # Run Report + Result = report_details.from_json(report_details) + api_response = api_instance.start_report(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_report(Result) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) /reports/{id}/cancel: post: tags: @@ -35735,6 +41701,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#cancel-report + source: | + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + api_instance.cancel_report(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) /reports/{taskResultId}: get: tags: @@ -35849,6 +41828,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report + source: | + 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 + + api_response = api_instance.get_report(task_result_id, file_format, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) /sod-policies: post: security: @@ -36275,6 +42272,76 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.create_sod_policy(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_sod_policy(Result) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) get: security: - userAuth: @@ -36429,6 +42496,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + 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) + 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 + + api_response = api_instance.list_sod_policies() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) /sod-policies/{id}: get: security: @@ -36560,6 +42646,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + 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 + + api_response = api_instance.get_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) put: security: - userAuth: @@ -36813,6 +42914,77 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + 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 + Result = sod_policy.from_json(sod_policy) + api_response = api_instance.put_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_sod_policy(id, Result) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) delete: security: - userAuth: @@ -36880,6 +43052,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy + source: | + 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 + + api_instance.delete_sod_policy(id, ) + + # Below is a request that includes all optional parameters + # api_instance.delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) patch: security: - userAuth: @@ -37061,6 +43247,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + [{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 + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # 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 + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_sod_policy(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_sod_policy(id, Result) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) /sod-policies/{id}/evaluate: post: security: @@ -37154,6 +43362,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + 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 + + api_response = api_instance.start_evaluate_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) /sod-policies/{id}/schedule: get: security: @@ -37271,6 +43494,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + 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 + + api_response = api_instance.get_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) put: security: - userAuth: @@ -37377,6 +43615,59 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + 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 + Result = sod_policy_schedule.from_json(sod_policy_schedule) + api_response = api_instance.put_policy_schedule(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_policy_schedule(id, Result) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) delete: security: - userAuth: @@ -37433,6 +43724,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + 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 + + api_instance.delete_sod_policy_schedule(id) + + # Below is a request that includes all optional parameters + # api_instance.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: @@ -37500,6 +43804,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + 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 + + api_response = api_instance.start_sod_policy(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) /sod-policies/{id}/violation-report: get: security: @@ -37567,6 +43886,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_status(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(api_response) + 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: @@ -37634,6 +43968,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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 + + api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) /sod-violations/predict: post: security: @@ -37848,6 +44197,32 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + 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. + Result = identity_with_new_access.from_json(identity_with_new_access) + api_response = api_instance.start_predict_sod_violations(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_predict_sod_violations(Result) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) /sod-violations/check: post: security: @@ -37977,6 +44352,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + 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 + Result = identity_with_new_access1.from_json(identity_with_new_access1) + api_response = api_instance.start_violation_check(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_violation_check(Result) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) /sod-violation-report/run: post: security: @@ -38055,6 +44445,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + 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 + + api_response = api_instance.start_sod_all_policies_for_org() + + # Below is a request that includes all optional parameters + # api_response = api_instance.start_sod_all_policies_for_org(Result) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) /sod-violation-report: get: security: @@ -38109,6 +44516,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + try: + # Get multi-report run task status + + api_response = api_instance.get_sod_all_report_run_status() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(api_response) + 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: @@ -38171,6 +44592,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + 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 + + api_response = api_instance.get_default_violation_report(report_result_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) /sod-violation-report/{reportResultId}/download/{fileName}: get: security: @@ -38241,6 +44677,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + 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 + + api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) /sources: get: operationId: listSources @@ -38695,6 +45147,27 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#list-sources + 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) + 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. + + api_response = api_instance.list_sources() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) post: operationId: createSource security: @@ -38849,6 +45322,104 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-source + source: | + 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. + Result = source.from_json(source) + api_response = api_instance.create_source(Result, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source(Result, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) /sources/{id}: get: operationId: getSource @@ -38915,6 +45486,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + api_response = api_instance.get_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) put: operationId: putSource security: @@ -39085,6 +45671,104 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-source + source: | + 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) + Result = source.from_json(source) + api_response = api_instance.put_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source(id, Result) + print("The response of SourcesApi->put_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) patch: operationId: updateSource security: @@ -39237,6 +45921,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + [{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). + 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) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source(id, Result) + print("The response of SourcesApi->update_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) delete: operationId: deleteSource security: @@ -39325,6 +46031,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-source + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + api_response = api_instance.delete_source(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) /sources/{sourceId}/provisioning-policies: get: operationId: listProvisioningPolicies @@ -39413,6 +46134,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#list-provisioning-policies + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + api_response = api_instance.list_provisioning_policies(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) post: operationId: createProvisioningPolicy tags: @@ -39597,6 +46333,61 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-provisioning-policy + source: | + 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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.create_provisioning_policy(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_provisioning_policy(source_id, Result) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) /sources/{sourceId}/provisioning-policies/{usageType}: get: operationId: getProvisioningPolicy @@ -39688,6 +46479,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + + api_response = api_instance.get_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) put: operationId: putProvisioningPolicy tags: @@ -39827,6 +46634,62 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->put_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) patch: operationId: updateProvisioningPolicy tags: @@ -39947,6 +46810,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v3.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. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Partial update of Provisioning Policy + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + print("The response of SourcesApi->update_provisioning_policy:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) delete: operationId: deleteProvisioningPolicy tags: @@ -40025,6 +46911,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-provisioning-policy + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v3.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 + + api_instance.delete_provisioning_policy(source_id, usage_type) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -40144,6 +47044,63 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policies-in-bulk + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + [sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | + 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" + } # List[ProvisioningPolicyDto] | + + try: + # Bulk Update Provisioning Policies + Result = provisioning_policy_dto.from_json(provisioning_policy_dto) + api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) /sources/{sourceId}/schemas: get: operationId: getSourceSchemas @@ -40353,6 +47310,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-schemas + source: | + 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 + + api_response = api_instance.get_source_schemas(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) post: operationId: createSourceSchema security: @@ -40459,6 +47433,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#create-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = sailpoint.v3.ModelSchema() # ModelSchema | + try: + # Create Schema on Source + Result = model_schema.from_json(model_schema) + api_response = api_instance.create_source_schema(source_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_source_schema(source_id, Result) + print("The response of SourcesApi->create_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) /sources/{sourceId}/schemas/{schemaId}: get: operationId: getSourceSchema @@ -40528,6 +47518,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-schema + source: | + 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 + + api_response = api_instance.get_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) put: operationId: putSourceSchema tags: @@ -40649,6 +47655,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#put-source-schema + source: | + 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.v3.ModelSchema() # ModelSchema | + try: + # Update Source Schema (Full) + Result = model_schema.from_json(model_schema) + api_response = api_instance.put_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->put_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) patch: operationId: updateSourceSchema tags: @@ -40776,6 +47799,29 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#update-source-schema + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + [{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. + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + + try: + # Update Source Schema (Partial) + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.update_source_schema(source_id, schema_id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + print("The response of SourcesApi->update_source_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) delete: operationId: deleteSourceSchema tags: @@ -40838,6 +47884,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#delete-source-schema + source: | + 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 + + api_instance.delete_source_schema(source_id, schema_id) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -40953,6 +48013,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-health + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + api_response = api_instance.get_source_health(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) /sources/{id}/schemas/accounts: get: tags: @@ -41015,6 +48090,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + api_instance.get_accounts_schema(id) + + # Below is a request that includes all optional parameters + # api_instance.get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) post: tags: - Sources @@ -41091,6 +48179,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-accounts-schema + source: | + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + api_response = api_instance.import_accounts_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) /sources/{id}/schemas/entitlements: get: tags: @@ -41161,6 +48265,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-entitlements-schema + source: | + 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 + + api_instance.get_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_instance.get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) post: tags: - Sources @@ -41244,6 +48362,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-entitlements-schema + source: | + 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 + + api_response = api_instance.import_entitlements_schema(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) /sources/{sourceId}/upload-connector-file: post: operationId: importConnectorFile @@ -41316,6 +48451,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#import-connector-file + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + api_response = api_instance.import_connector_file(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) /sources/{sourceId}/connections: get: operationId: getSourceConnections @@ -41526,6 +48677,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sources#get-source-connections + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source Connections by ID + + api_response = api_instance.get_source_connections(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_source_connections(id) + print("The response of SourcesApi->get_source_connections:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) /tagged-objects: get: operationId: listTaggedObjects @@ -41642,6 +48808,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects + 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) + 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 + + api_response = api_instance.list_tagged_objects() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) post: operationId: setTagToObject security: @@ -41706,6 +48890,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tag-to-object + source: | + tagged_object = { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } # TaggedObject | + try: + # Add Tag to Object + Result = tagged_object.from_json(tagged_object) + api_instance.set_tag_to_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.set_tag_to_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) /tagged-objects/{type}: get: operationId: listTaggedObjectsByType @@ -41803,6 +49007,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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 + + api_response = api_instance.list_tagged_objects_by_type(type, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) /tagged-objects/{type}/{id}: get: operationId: getTaggedObject @@ -41880,6 +49103,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#get-tagged-object + source: | + 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 + + api_response = api_instance.get_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) put: operationId: putTaggedObject security: @@ -41973,6 +49212,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#put-tagged-object + source: | + 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 + Result = tagged_object.from_json(tagged_object) + api_response = api_instance.put_tagged_object(type, id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_tagged_object(type, id, Result) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) delete: operationId: deleteTaggedObject security: @@ -42043,6 +49306,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tagged-object + source: | + 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 + + api_instance.delete_tagged_object(type, id) + + # Below is a request that includes all optional parameters + # api_instance.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 @@ -42165,6 +49442,33 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tags-to-many-objects + source: | + 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 + Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object) + api_response = api_instance.set_tags_to_many_objects(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.set_tags_to_many_objects(Result) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) /tagged-objects/bulk-remove: post: operationId: deleteTagsToManyObject @@ -42256,6 +49560,30 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tags-to-many-object + source: | + 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 + Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object) + api_instance.delete_tags_to_many_object(Result) + + # Below is a request that includes all optional parameters + # api_instance.delete_tags_to_many_object(Result) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) /transforms: get: tags: @@ -42379,6 +49707,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#list-transforms + source: | + 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 + + api_response = api_instance.list_transforms() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) post: tags: - Transforms @@ -42590,6 +49937,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#create-transform + source: | + transform = { + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + } # Transform | The transform to be created. + try: + # Create transform + Result = transform.from_json(transform) + api_response = api_instance.create_transform(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_transform(Result) + print("The response of TransformsApi->create_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) /transforms/{id}: get: tags: @@ -42657,6 +50023,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#get-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + api_response = api_instance.get_transform(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) put: tags: - Transforms @@ -42766,6 +50147,26 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#update-transform + source: | + 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 + + api_response = api_instance.update_transform(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.update_transform(id, Result) + print("The response of TransformsApi->update_transform:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) delete: tags: - Transforms @@ -42827,6 +50228,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/transforms#delete-transform + source: | + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + api_instance.delete_transform(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) /work-items: get: operationId: listWorkItems @@ -42980,6 +50394,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + api_response = api_instance.list_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) /work-items/completed: get: operationId: getCompletedWorkItems @@ -43046,6 +50478,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items + source: | + 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 + + api_response = api_instance.get_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) /work-items/count: get: operationId: getCountWorkItems @@ -43105,6 +50555,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items + source: | + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + api_response = api_instance.get_count_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) /work-items/completed/count: get: operationId: getCountCompletedWorkItems @@ -43160,6 +50625,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + api_response = api_instance.get_count_completed_work_items() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) /work-items/summary: get: operationId: getWorkItemsSummary @@ -43227,6 +50707,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary + source: | + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + api_response = api_instance.get_work_items_summary() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) /work-items/{id}: get: operationId: getWorkItem @@ -43283,6 +50778,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item + source: | + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + api_response = api_instance.get_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) post: operationId: completeWorkItem tags: @@ -43341,6 +50851,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Complete a Work Item + + api_response = api_instance.complete_work_item(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.complete_work_item(id) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) /work-items/{id}/forward: post: operationId: sendWorkItemForward @@ -43426,6 +50951,24 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + work_item_forward = { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } # WorkItemForward | + try: + # Forward a Work Item + Result = work_item_forward.from_json(work_item_forward) + api_instance.send_work_item_forward(id, Result) + + # Below is a request that includes all optional parameters + # api_instance.send_work_item_forward(id, Result) + except Exception as e: + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) /work-items/{id}/approve/{approvalItemId}: post: operationId: approveApprovalItem @@ -43493,6 +51036,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item + source: | + 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 + + api_response = api_instance.approve_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) /work-items/{id}/reject/{approvalItemId}: post: operationId: rejectApprovalItem @@ -43560,6 +51119,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item + source: | + 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 + + api_response = api_instance.reject_approval_item(id, approval_item_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) /work-items/bulk-approve/{id}: post: operationId: approveApprovalItemsInBulk @@ -43619,6 +51194,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + api_response = api_instance.approve_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(api_response) + 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 @@ -43678,6 +51268,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk + source: | + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + api_response = api_instance.reject_approval_items_in_bulk(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(api_response) + 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 @@ -43749,6 +51354,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection + source: | + 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 + Result = request_body.from_json(request_body) + api_response = api_instance.submit_account_selection(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.submit_account_selection(id, Result) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) /workflows: get: operationId: listWorkflows @@ -43861,6 +51482,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows + source: | + try: + # List Workflows + + api_response = api_instance.list_workflows() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) post: operationId: createWorkflow tags: @@ -44175,6 +51810,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow + source: | + 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 + Result = create_workflow_request.from_json(create_workflow_request) + api_response = api_instance.create_workflow(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow(Result) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) /workflows/{id}: get: operationId: getWorkflow @@ -44235,6 +51885,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + api_response = api_instance.get_workflow(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) put: operationId: putWorkflow tags: @@ -44343,6 +52008,60 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow + source: | + 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", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } # WorkflowBody | + try: + # Update Workflow + Result = workflow_body.from_json(workflow_body) + api_response = api_instance.put_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.put_workflow(id, Result) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) patch: operationId: patchWorkflow tags: @@ -44460,6 +52179,28 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + [{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] | + json_patch_operation = { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } # List[JsonPatchOperation] | + + try: + # Patch Workflow + Result = json_patch_operation.from_json(json_patch_operation) + api_response = api_instance.patch_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.patch_workflow(id, Result) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) delete: operationId: deleteWorkflow tags: @@ -44515,6 +52256,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#delete-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + api_instance.delete_workflow(id) + + # Below is a request that includes all optional parameters + # api_instance.delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) /workflows/{id}/test: post: operationId: testWorkflow @@ -44623,6 +52377,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow + source: | + 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 + Result = test_workflow_request.from_json(test_workflow_request) + api_response = api_instance.test_workflow(id, Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_workflow(id, Result) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) /workflows/{id}/executions: get: operationId: getWorkflowExecutions @@ -44754,6 +52524,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-executions + source: | + 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 + + api_response = api_instance.get_workflow_executions(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) /workflow-executions/{id}: get: operationId: getWorkflowExecution @@ -44818,6 +52607,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + api_response = api_instance.get_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) /workflow-executions/{id}/history: get: operationId: getWorkflowExecutionHistory @@ -44913,6 +52717,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution-history + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + api_response = api_instance.get_workflow_execution_history(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) /workflow-executions/{id}/cancel: post: operationId: cancelWorkflowExecution @@ -44972,6 +52791,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#cancel-workflow-execution + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + api_instance.cancel_workflow_execution(id) + + # Below is a request that includes all optional parameters + # api_instance.cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) /workflow-library: get: operationId: listCompleteWorkflowLibrary @@ -45361,6 +53193,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-complete-workflow-library + 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) + try: + # List Complete Workflow Library + + api_response = api_instance.list_complete_workflow_library() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) /workflow-library/actions: get: operationId: listWorkflowLibraryActions @@ -45435,6 +53283,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-actions + 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) + 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 + + api_response = api_instance.list_workflow_library_actions() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) /workflow-library/triggers: get: operationId: listWorkflowLibraryTriggers @@ -45509,6 +53374,23 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-triggers + 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) + 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 + + api_response = api_instance.list_workflow_library_triggers() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) /workflow-library/operators: get: operationId: listWorkflowLibraryOperators @@ -45560,6 +53442,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators + source: | + try: + # List Workflow Library Operators + + api_response = api_instance.list_workflow_library_operators() + + # Below is a request that includes all optional parameters + # api_response = api_instance.list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) /workflows/{id}/external/oauth-clients: post: operationId: createWorkflowExternalTrigger @@ -45632,6 +53528,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow-external-trigger + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + api_response = api_instance.create_workflow_external_trigger(id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) /workflows/execute/external/{id}: post: operationId: createExternalExecuteWorkflow @@ -45716,6 +53627,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = sailpoint.v3.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + api_response = api_instance.create_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) /workflows/execute/external/{id}/test: post: operationId: testExternalExecuteWorkflow @@ -45796,6 +53723,22 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow + source: | + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = sailpoint.v3.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + api_response = api_instance.test_external_execute_workflow(id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.test_external_execute_workflow(id, Result) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) /source-usages/{sourceId}/status: get: tags: @@ -45867,6 +53810,21 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id + source: | + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + api_response = api_instance.get_status_by_source_id(source_id) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) /source-usages/{sourceId}/summaries: get: tags: @@ -45958,6 +53916,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id + source: | + 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 + + api_response = api_instance.get_usages_by_source_id(source_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) /account-usages/{accountId}/summaries: get: tags: @@ -46049,6 +54026,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + 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 + + api_response = api_instance.get_usages_by_account_id(account_id, ) + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) /manual-discover-applications-template: get: summary: Download CSV Template for Discovery @@ -46112,6 +54108,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + try: + # Download CSV Template for Discovery + + api_response = api_instance.get_manual_discover_applications_csv_template() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(api_response) + 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 @@ -46175,6 +54185,19 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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 + + api_instance.send_manual_discover_applications_csv_template(file) + + # Below is a request that includes all optional parameters + # api_instance.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) /discovered-applications: get: operationId: getDiscoveredApplications @@ -46488,6 +54511,25 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-discovered-applications + 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) + 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 + + api_response = api_instance.get_discovered_applications() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) /vendor-connector-mappings: get: security: @@ -46671,6 +54713,20 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + try: + # List Vendor Connector Mappings + + api_response = api_instance.get_vendor_connector_mappings() + + # Below is a request that includes all optional parameters + # api_response = api_instance.get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) post: security: - userAuth: @@ -46756,6 +54812,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.create_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.create_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) delete: security: - userAuth: @@ -46845,6 +54938,43 @@ paths: Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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 + Result = vendor_connector_mapping.from_json(vendor_connector_mapping) + api_response = api_instance.delete_vendor_connector_mapping(Result) + + # Below is a request that includes all optional parameters + # api_response = api_instance.delete_vendor_connector_mapping(Result) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) security: - userAuth: - sp:scopes:all @@ -47307,6 +55437,7 @@ components: description: Name of the Object type: string example: aName + nullable: true created: description: Creation date of the Object type: string